annotate lisp/packages/auto-save.el @ 149:538048ae2ab8 r20-3b1

Import from CVS: tag r20-3b1
author cvs
date Mon, 13 Aug 2007 09:36:16 +0200
parents 34a5b81f86ba
children a2f645c6b9f8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
1 ;; -*- Emacs-Lisp -*-
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
2 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
3 ;;
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
4 ;; File: auto-save.el
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 134
diff changeset
5 ;; Version: $Revision: 1.5 $
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
6 ;; RCS:
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
7 ;; Description: Safer autosaving with support for efs and /tmp.
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
8 ;; This version of auto-save is designed to work with efs,
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
9 ;; instead of ange-ftp.
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
10 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>,
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
11 ;;
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
12 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 134
diff changeset
14 (defconst auto-save-version (substring "$Revision: 1.5 $" 11 -2)
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
15 "Version number of auto-save.")
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
17 ;;; Copyright (C) 1992 by Sebastian Kremer <sk@thp.uni-koeln.de>
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
18
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
19 ;;; This program is free software; you can redistribute it and/or modify
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
20 ;;; it under the terms of the GNU General Public License as published by
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
21 ;;; the Free Software Foundation; either version 1, or (at your option)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
22 ;;; any later version.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
24 ;;; This program is distributed in the hope that it will be useful,
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
25 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
26 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
27 ;;; GNU General Public License for more details.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
29 ;;; You should have received a copy of the GNU General Public License
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
30 ;;; along with this program; if not, write to the Free Software
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
31 ;;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 ;;;; OVERVIEW ==========================================================
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
35 ;;; Combines autosaving for efs (to a local or remote directory)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
36 ;;; with the ability to do autosaves to a fixed directory on a local
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
37 ;;; disk, in case NFS is slow. The auto-save file used for
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
38 ;;; /usr/foo/bar/baz.txt
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
39 ;;; will be
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
40 ;;; AUTOSAVE/#\!usr\!foo\!bar\!baz.txt#
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
41 ;;; assuming AUTOSAVE is the non-nil value of the variable
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
42 ;;; `auto-save-directory'.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
44 ;;; Takes care that autosave files for non-file-buffers (e.g. *mail*)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
45 ;;; from two simultaneous Emacses don't collide.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
47 ;;; Autosaves even if the current directory is not writable.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
49 ;;; Can limit autosave names to 14 characters using a hash function,
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
50 ;;; see `auto-save-hash-p'.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
52 ;;; See `auto-save-directory' and `make-auto-save-file-name' and
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
53 ;;; references therein for complete documentation.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
55 ;;; Meta-x recover-all-files will effectively do recover-file on all
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
56 ;;; files whose autosave file is newer (one of the benefits of having
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
57 ;;; all autosave files in the same place).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 ;;;; INSTALLATION ======================================================
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
61 ;;; Put this file into your load-path and the following in your ~/.emacs:
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
63 ;;; If you want to autosave in the fixed directory /tmp/USER-autosave/
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
64 ;;; (setq auto-save-directory
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
65 ;;; (concat "/tmp/" (user-login-name) "-autosave/"))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
67 ;;; If you don't want to save in /tmp (e.g., because it is swap
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
68 ;;; mounted) but rather in ~/autosave/
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
69 ;;; (setq auto-save-directory (expand-file-name "~/autosave/"))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
71 ;;; If you want to save each file in its own directory (the default)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
72 ;;; (setq auto-save-directory nil)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
73 ;;; You still can take advantage of autosaving efs remote files
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
74 ;;; in a fixed local directory, `auto-save-directory-fallback' will
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
75 ;;; be used.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
77 ;;; If you want to use 14 character hashed autosave filenames
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
78 ;;; (setq auto-save-hash-p t)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
80 ;;; Finally, put this line after the others in your ~/.emacs:
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
81 ;;; (require 'auto-save)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 ;;;; ACKNOWLEDGEMENT ===================================================
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
86 ;;; This code is loosely derived from autosave-in-tmp.el by Jamie
149
538048ae2ab8 Import from CVS: tag r20-3b1
cvs
parents: 134
diff changeset
87 ;;; Zawinski <jwz@netscape.com> (the version I had was last modified 22
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
88 ;;; dec 90 jwz) and code submitted to ange-ftp-lovers on Sun, 5 Apr
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
89 ;;; 92 23:20:47 EDT by drw@BOURBAKI.MIT.EDU (Dale R. Worley).
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
90 ;;; auto-save.el tries to cover the functionality of those two
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
91 ;;; packages.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
93 ;;; Valuable comments and help from Dale Worley, Andy Norman, Jamie
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
94 ;;; Zawinski and Sandy Rutherford are gratefully acknowledged.
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
95
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
96 ;;;; PROVISION ========================================================
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
97
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
98 (provide 'auto-save)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 ;;;; CUSTOMIZATION =====================================================
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
102 (defgroup auto-save nil
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
103 "Autosaving with support for efs and /tmp"
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
104 :group 'data)
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
105
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
106 (put 'auto-save-interval 'custom-type 'integer)
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
107 (put 'auto-save-interval 'factory-value '(300))
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
108 (custom-add-to-group 'auto-save 'auto-save-interval 'custom-variable)
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
109
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
110 (defcustom auto-save-directory nil
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112 ;;; Don't make this user-variable-p, it should be set in .emacs and
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 ;;; left at that. In particular, it should remain constant across
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 ;;; several Emacs session to make recover-all-files work.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 "If non-nil, fixed directory for autosaving: all autosave files go
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
117 there. If this directory does not yet exist at load time, it is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
118 created and its mode is set to 0700 so that nobody else can read your
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 autosave files.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 If nil, each autosave files goes into the same directory as its
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122 corresponding visited file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124 A non-nil `auto-save-directory' could be on a local disk such as in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125 /tmp, then auto-saves will always be fast, even if NFS or the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
126 automounter is slow. In the usual case of /tmp being locally mounted,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
127 note that if you run emacs on two different machines, they will not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128 see each other's auto-save files.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130 The value \(expand-file-name \"~/autosave/\"\) might be better if /tmp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
131 is mounted from swap (possible in SunOS, type `df /tmp' to find out)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
132 and thus vanishes after a reboot, or if your system is particularly
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
133 thorough when cleaning up /tmp, clearing even non-empty subdirectories.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
134
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
135 It should never be an efs remote filename because that would
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
136 defeat `efs-auto-save-remotely'.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138 Unless you set `auto-save-hash-p', you shouldn't set this to a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 directory in a filesystem that does not support long filenames, since
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 a file named
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
142 /home/sk/lib/emacs/lisp/auto-save.el
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144 will have a longish filename like
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146 AUTO-SAVE-DIRECTORY/#\\!home\\!sk\\!lib\\!emacs\\!lisp\\!auto-save.el#
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
147
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
148 as auto save file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
149
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
150 See also variables `auto-save-directory-fallback',
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
151 `efs-auto-save' and `efs-auto-save-remotely'."
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
152 :type '(choice (const :tag "same as file" nil)
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
153 directory)
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
154 :group 'auto-save)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
156
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
157 (defcustom auto-save-hash-p nil
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
158 "If non-nil, hashed autosave names of length 14 are used.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
159 This is to avoid autosave filenames longer than 14 characters.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
160 The directory used is `auto-save-hash-directory' regardless of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161 `auto-save-directory'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162 Hashing defeats `recover-all-files', you have to recover files
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
163 individually by doing `recover-file'."
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
164 :type 'boolean
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
165 :group 'auto-save)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
167 ;;; This defvar is in efs.el now, but doesn't hurt to give it here as
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
168 ;;; well so that loading first auto-save.el does not abort.
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
169 (or (boundp 'efs-auto-save) (defvar efs-auto-save 0))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
170 (or (boundp 'efs-auto-save-remotely) (defvar efs-auto-save-remotely nil))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
171
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
172 (defcustom auto-save-offer-delete nil
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
173 "*If non-nil, `recover-all-files' offers to delete autosave files
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
174 that are out of date or were dismissed for recovering.
120
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
175 Special value 'always deletes those files silently."
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
176 :type '(choice (const :tag "on" t)
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
177 (const :tag "off" nil)
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
178 (const :tag "delete silently" always))
cca96a509cfe Import from CVS: tag r20-1b12
cvs
parents: 100
diff changeset
179 :group 'auto-save)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
180
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
181 ;;;; end of customization
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
182
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
184 ;;; Preparations to be done at load time
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
185
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
186 (defvar auto-save-directory-fallback (expand-file-name "~/autosave/")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
187 ;; not user-variable-p, see above
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
188 "Directory used for local autosaving of remote files if
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
189 both `auto-save-directory' and `efs-auto-save-remotely' are nil.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
190 Also used if a working directory to be used for autosaving is not writable.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
191 This *must* always be the name of directory that exists or can be
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
192 created by you, never nil.")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
193
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
194 (defvar auto-save-hash-directory
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
195 (expand-file-name "hash/" (or auto-save-directory
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
196 auto-save-directory-fallback))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
197 "If non-nil, directory used for hashed autosave filenames.")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
198
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
199 (defun auto-save-check-directory (var)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
200 (let ((dir (symbol-value var)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
201 (if (null dir)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
202 nil
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
203 ;; Expand and store back into the variable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
204 (set var (setq dir (expand-file-name dir)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
205 ;; Make sure directory exists
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
206 (if (file-directory-p dir)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
207 nil
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
208 ;; Else we create and chmod 0700 the directory
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
209 (setq dir (directory-file-name dir)) ; some systems need this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
210 (if (fboundp 'make-directory) ; V19 or tree dired
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
211 (make-directory dir)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
212 (call-process "mkdir" nil nil nil dir))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
213 (set-file-modes dir (* 7 8 8))))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
214
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
215 (mapcar (function auto-save-check-directory)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
216 '(auto-save-directory auto-save-directory-fallback))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
217
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
218 (and auto-save-hash-p
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
219 (auto-save-check-directory 'auto-save-hash-directory))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
220
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
221
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
222 ;;; Computing an autosave name for a file and vice versa
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
223
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
224 (defun make-auto-save-file-name ();; redefines files.el
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
225 ;; auto-save-file-name-p need not be redefined.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
226
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
227 "Return file name to use for auto-saves of current buffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
228 Does not consider `auto-save-visited-file-name'; that is checked
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
229 before calling this function.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
230
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
231 Offers to autosave all files in the same `auto-save-directory'. All
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
232 autosave files can then be recovered at once with function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
233 `recover-all-files'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
234
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
235 Takes care to make autosave files for files accessed through efs
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
236 be local files if variable `efs-auto-save-remotely' is nil.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
237
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
238 Takes care of slashes in buffer names to prevent autosave errors.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
239
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
240 Takes care that autosave files for buffers not visiting any file (such
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
241 as `*mail*') from two simultaneous Emacses don't collide by prepending
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
242 the Emacs pid.
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
243
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
244 Uses 14 character autosave names if `auto-save-hash-p' is true.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
245
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
246 Autosaves even if the current directory is not writable, using
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
247 directory `auto-save-directory-fallback'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
248
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
249 You can redefine this for customization (he he :-).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
250 See also function `auto-save-file-name-p'."
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
251
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
252 ;; We have to be very careful about not signalling an error in this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
253 ;; function since files.el does not provide for this (e.g. find-file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
254 ;; would fail for each new file).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
255
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
256 (condition-case error-data
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
257 (let* ((file-name (or (and (boundp 'buffer-file-truename)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
258 buffer-file-truename
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
259 ;; Make sure that the file name is expanded.
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
260 (expand-file-name buffer-file-name))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
261 (and buffer-file-name
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
262 (expand-file-name buffer-file-name))))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
263 ;; So autosavename looks like #%...#, roughly as with the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
264 ;; old make-auto-save-file-name function. The
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
265 ;; make-temp-name inserts the pid of this Emacs: this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
266 ;; avoids autosaving from two Emacses into the same file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
267 ;; It cannot be recovered automatically then because in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
268 ;; the next Emacs session (the one after the crash) the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
269 ;; pid will be different, but file-less buffers like
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
270 ;; *mail* must be recovered manually anyway.
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
271
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
272 ;; jwz: putting the emacs PID in the auto-save file name is bad
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
273 ;; news, because that defeats auto-save-recovery of *mail*
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
274 ;; buffers -- the (sensible) code in sendmail.el calls
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
275 ;; (make-auto-save-file-name) to determine whether there is
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
276 ;; unsent, auto-saved mail to recover. If that mail came from a
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
277 ;; previous emacs process (far and away the most likely case)
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
278 ;; then this can never succeed as the pid differs.
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
279 ;; (name-prefix (if file-name nil (make-temp-name "#%")))
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
280 (name-prefix (if file-name nil "#%"))
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
281
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
282 (save-name (or file-name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
283 ;; Prevent autosave errors. Buffername
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
284 ;; (to become non-dir part of filename) will
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
285 ;; be unslashified twice. Don't care.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
286 (auto-save-unslashify-name (buffer-name))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
287 (remote-p (and (stringp file-name)
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
288 (fboundp 'efs-ftp-path)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
289 (efs-ftp-path file-name))))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
290 ;; Return the appropriate auto save file name:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
291 (expand-file-name;; a buffername needs this, a filename not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
292 (if remote-p
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
293 (if efs-auto-save-remotely
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
294 (auto-save-name-in-same-directory save-name)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
295 ;; We have to use the `fixed-directory' now since the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
296 ;; `same-directory' would be remote.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
297 ;; It will use the fallback if needed.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
298 (auto-save-name-in-fixed-directory save-name))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
299 ;; Else it is a local file (or a buffer without a file, hence
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
300 ;; the name-prefix).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
301 ;; Hashed files always go into the special hash dir, never
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
302 ;; in the same directory, to make recognizing reliable.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
303 (if (or auto-save-directory auto-save-hash-p)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
304 (auto-save-name-in-fixed-directory save-name name-prefix)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
305 (auto-save-name-in-same-directory save-name name-prefix)))))
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
306
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
307 ;; If any error occurs in the above code, return what the old
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
308 ;; version of this function would have done. It is not ok to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
309 ;; return nil, e.g., when after-find-file tests
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
310 ;; file-newer-than-file-p, nil would bomb.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
311
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
312 (error (progn
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
313 (message "make-auto-save-file-name %s" error-data)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
314 (sit-for 2)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
315 (if buffer-file-name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
316 (concat (file-name-directory buffer-file-name)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
317 "#"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
318 (file-name-nondirectory buffer-file-name)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
319 "#")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
320 (expand-file-name (concat "#%" (buffer-name) "#")))))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
321
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
322 (defun auto-save-original-name (savename)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
323 "Reverse of `make-auto-save-file-name'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
324 Returns nil if SAVENAME was not associated with a file (e.g., it came
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
325 from an autosaved `*mail*' buffer) or does not appear to be an
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
326 autosave file at all.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
327 Hashed files are not understood, see `auto-save-hash-p'."
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
328 (let ((basename (file-name-nondirectory savename))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
329 (savedir (file-name-directory savename)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
330 (cond ((or (not (auto-save-file-name-p basename))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
331 (string-match "^#%" basename))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
332 nil)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
333 ;; now we know it looks like #...# thus substring is safe to use
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
334 ((or (equal savedir auto-save-directory) ; 2nd arg may be nil
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
335 (equal savedir auto-save-directory-fallback))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
336 ;; it is of the `-fixed-directory' type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
337 (auto-save-slashify-name (substring basename 1 -1)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
338 (t
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
339 ;; else it is of `-same-directory' type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
340 (concat savedir (substring basename 1 -1))))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
341
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
342 (defun auto-save-name-in-fixed-directory (filename &optional prefix)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
343 ;; Unslashify and enclose the whole FILENAME in `#' to make an auto
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
344 ;; save file in the auto-save-directory, or if that is nil, in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
345 ;; auto-save-directory-fallback (which must be the name of an
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
346 ;; existing directory). If the results would be too long for 14
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
347 ;; character filenames, and `auto-save-hash-p' is set, hash FILENAME
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
348 ;; into a shorter name.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
349 ;; Optional PREFIX is string to use instead of "#" to prefix name.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
350 (let ((base-name (concat (or prefix "#")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
351 (auto-save-unslashify-name filename)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
352 "#")))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
353 (if (and auto-save-hash-p
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
354 auto-save-hash-directory
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
355 (> (length base-name) 14))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
356 (expand-file-name (auto-save-cyclic-hash-14 filename)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
357 auto-save-hash-directory)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
358 (expand-file-name base-name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
359 (or auto-save-directory
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
360 auto-save-directory-fallback)))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
361
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
362 (defun auto-save-name-in-same-directory (filename &optional prefix)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
363 ;; Enclose the non-directory part of FILENAME in `#' to make an auto
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
364 ;; save file in the same directory as FILENAME. But if this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
365 ;; directory is not writable, use auto-save-directory-fallback.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
366 ;; FILENAME is assumed to be in non-directory form (no trailing slash).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
367 ;; It may be a name without a directory part (pesumably it really
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
368 ;; comes from a buffer name then), the fallback is used then.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
369 ;; Optional PREFIX is string to use instead of "#" to prefix name.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
370 (let ((directory (file-name-directory filename)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
371 (or (null directory)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
372 (file-writable-p directory)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
373 (setq directory auto-save-directory-fallback))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
374 (concat directory ; (concat nil) is ""
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
375 (or prefix "#")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
376 (file-name-nondirectory filename)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
377 "#")))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
378
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
379 (defun auto-save-unslashify-name (s)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
380 ;; "Quote any slashes in string S by replacing them with the two
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
381 ;;characters `\\!'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
382 ;;Also, replace any backslash by double backslash, to make it one-to-one."
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
383 (let ((limit 0))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
384 (while (string-match "[/\\]" s limit)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
385 (setq s (concat (substring s 0 (match-beginning 0))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
386 (if (string= (substring s
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
387 (match-beginning 0)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
388 (match-end 0))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
389 "/")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
390 "\\!"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
391 "\\\\")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
392 (substring s (match-end 0))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
393 (setq limit (1+ (match-end 0)))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
394 s)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
395
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
396 (defun auto-save-slashify-name (s)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
397 ;;"Reverse of `auto-save-unslashify-name'."
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
398 (let (pos)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
399 (while (setq pos (string-match "\\\\[\\!]" s pos))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
400 (setq s (concat (substring s 0 pos)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
401 (if (eq ?! (aref s (1+ pos))) "/" "\\")
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
402 (substring s (+ pos 2)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
403 pos (1+ pos))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
404 s)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
405
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
406
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
407 ;;; Hashing for autosave names
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
408
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
409 ;;; Hashing function contributed by Andy Norman <ange@hplb.hpl.hp.com>
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
410 ;;; based upon C code from pot@fly.cnuce.cnr.IT (Francesco Potorti`).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
411
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
412 (defun auto-save-cyclic-hash-14 (s)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
413 ;; "Hash string S into a string of length 14.
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
414 ;; A 7-bytes cyclic code for burst correction is calculated on a
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
415 ;; byte-by-byte basis. The polynomial used is D^7 + D^6 + D^3 +1.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
416 ;; The resulting string consists of hexadecimal digits [0-9a-f].
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
417 ;; In particular, it contains no slash, so it can be used as autosave name."
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
418 (let ((crc (make-string 7 0))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
419 result)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
420 (mapcar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
421 (function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
422 (lambda (new)
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
423 (setq new (+ new (aref crc 6)))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
424 (aset crc 6 (+ (aref crc 5) new))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
425 (aset crc 5 (aref crc 4))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
426 (aset crc 4 (aref crc 3))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
427 (aset crc 3 (+ (aref crc 2) new))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
428 (aset crc 2 (aref crc 1))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
429 (aset crc 1 (aref crc 0))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
430 (aset crc 0 new)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
431 s)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
432 (setq result (format "%02x%02x%02x%02x%02x%02x%02x"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
433 (aref crc 0)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
434 (aref crc 1)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
435 (aref crc 2)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
436 (aref crc 3)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
437 (aref crc 4)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
438 (aref crc 5)
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
439 (aref crc 6)))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
440 result))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
441
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
442 ;; This leaves two characters that could be used to wrap it in `#' or
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
443 ;; make two filenames from it: one for autosaving, and another for a
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
444 ;; file containing the name of the autosaved filed, to make hashing
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
445 ;; reversible.
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
446 (defun auto-save-cyclic-hash-12 (s)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
447 "Outputs the 12-characters ascii hex representation of a 6-bytes
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
448 cyclic code for burst correction calculated on STRING on a
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
449 byte-by-byte basis. The used polynomial is D^6 + D^5 + D^4 + D^3 +1."
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
450 (let ((crc (make-string 6 0)))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
451 (mapcar
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
452 (function
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
453 (lambda (new)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
454 (setq new (+ new (aref crc 5)))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
455 (aset crc 5 (+ (aref crc 4) new))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
456 (aset crc 4 (+ (aref crc 3) new))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
457 (aset crc 3 (+ (aref crc 2) new))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
458 (aset crc 2 (aref crc 1))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
459 (aset crc 1 (aref crc 0))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
460 (aset crc 0 new)))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
461 s)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
462 (format "%02x%02x%02x%02x%02x%02x"
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
463 (aref crc 0)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
464 (aref crc 1)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
465 (aref crc 2)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
466 (aref crc 3)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
467 (aref crc 4)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
468 (aref crc 5))))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
469
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
470
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
471
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
472 ;;; Recovering files
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
473
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
474 (defun recover-all-files (&optional silent)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
475 "Do recover-file for all autosave files which are current.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
476 Only works if you have a non-nil `auto-save-directory'.
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
477
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
478 Optional prefix argument SILENT means to be silent about non-current
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
479 autosave files. This is useful if invoked automatically at Emacs
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
480 startup.
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
481
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
482 If `auto-save-offer-delete' is t, this function will offer to delete
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
483 old or rejected autosave files.
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
484
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
485 Hashed files (see `auto-save-hash-p') are not understood, use
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
486 `recover-file' to recover them individually."
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
487 (interactive "P")
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
488 (let ((savefiles (directory-files auto-save-directory t "^#"))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
489 afile ; the auto save file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
490 file ; its original file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
491 (total 0) ; # of files offered to recover
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
492 (count 0)) ; # of files actually recovered
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
493 (or (equal auto-save-directory auto-save-directory-fallback)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
494 (setq savefiles
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
495 (append savefiles
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
496 (directory-files auto-save-directory-fallback t "^#"))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
497 (while savefiles
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
498 (setq afile (car savefiles)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
499 file (auto-save-original-name afile)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
500 savefiles (cdr savefiles))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
501 (cond ((and file (not (file-newer-than-file-p afile file)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
502 (message "autosave file \"%s\" is not current." afile)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
503 (sit-for 2))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
504 (t
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
505 (setq total (1+ total))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
506 (with-output-to-temp-buffer "*Directory*"
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
507 (apply 'call-process "ls" nil standard-output nil
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
508 "-l" afile (if file (list file))))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
509 (if (yes-or-no-p (format "Recover %s from auto save file? "
134
34a5b81f86ba Import from CVS: tag r20-2b1
cvs
parents: 120
diff changeset
510 (or file "non-file buffer")))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
511 (let* ((obuf (current-buffer))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
512 (buf (set-buffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
513 (if file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
514 (find-file-noselect file t)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
515 (generate-new-buffer "*recovered*"))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
516 (buffer-read-only nil))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
517 (erase-buffer)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
518 (insert-file-contents afile nil)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
519 (condition-case ()
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
520 (after-find-file nil)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
521 (error nil))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
522 (setq buffer-auto-save-file-name nil)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
523 (setq count (1+ count))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
524 (message "\
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
525 Auto-save off in buffer \"%s\" till you do M-x auto-save-mode."
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
526 (buffer-name))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
527 (set-buffer obuf)
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
528 (sit-for 1))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
529 ;; If not used for recovering, offer to delete
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
530 ;; autosave file
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
531 (and auto-save-offer-delete
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
532 (or (eq 'always auto-save-offer-delete)
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
533 (yes-or-no-p
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
534 (format "Delete autosave file for `%s'? " file)))
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
535 (delete-file afile))))))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
536 (if (zerop total)
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
537 (or silent (message "Nothing to recover."))
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
538 (message "%d/%d file%s recovered." count total (if (= count 1) "" "s"))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
539 (if (get-buffer "*Directory*") (kill-buffer "*Directory*")))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
540
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 70
diff changeset
541 ;;; end of auto-save.el