]> code.delx.au - gnu-emacs/blob - lisp/tar-mode.el
(abs, ceiling, floor): Remove, since they now redefine
[gnu-emacs] / lisp / tar-mode.el
1 ;;; tar-mode.el --- simple editing of tar files from GNU emacs
2
3 ;;; Copyright (C) 1990, 1991, 1993 Free Software Foundation, Inc.
4
5 ;; Author: Jamie Zawinski <jwz@lucid.com>
6 ;; Created: 04 Apr 1990
7 ;; Version: 1.21bis (some cleanup by ESR)
8 ;; Keywords: unix
9
10 ;;; This file is part of GNU Emacs.
11 ;;;
12 ;;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;;; it under the terms of the GNU General Public License as published by
14 ;;; the Free Software Foundation; either version 2, or (at your option)
15 ;;; any later version.
16 ;;;
17 ;;; GNU Emacs is distributed in the hope that it will be useful,
18 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;;; GNU General Public License for more details.
21 ;;;
22 ;;; You should have received a copy of the GNU General Public License
23 ;;; along with GNU Emacs; see the file COPYING. If not, write to
24 ;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25
26 ;;; Commentary:
27
28 ;;; This package attempts to make dealing with Unix 'tar' archives easier.
29 ;;; When this code is loaded, visiting a file whose name ends in '.tar' will
30 ;;; cause the contents of that archive file to be displayed in a Dired-like
31 ;;; listing. It is then possible to use the customary Dired keybindings to
32 ;;; extract sub-files from that archive, either by reading them into their own
33 ;;; editor buffers, or by copying them directly to arbitrary files on disk.
34 ;;; It is also possible to delete sub-files from within the tar file and write
35 ;;; the modified archive back to disk, or to edit sub-files within the archive
36 ;;; and re-insert the modified files into the archive. See the documentation
37 ;;; string of tar-mode for more info.
38
39 ;;; This code now understands the extra fields that GNU tar adds to tar files.
40
41 ;;; This interacts correctly with "uncompress.el" in the Emacs library,
42 ;;; which you get with
43 ;;;
44 ;;; (autoload 'uncompress-while-visiting "uncompress")
45 ;;; (setq auto-mode-alist (cons '("\\.Z$" . uncompress-while-visiting)
46 ;;; auto-mode-alist))
47 ;;;
48 ;;; Do not attempt to use tar-mode.el with crypt.el, you will lose.
49
50 ;;; *************** TO DO ***************
51 ;;;
52 ;;; o chmod should understand "a+x,og-w".
53 ;;;
54 ;;; o It's not possible to add a NEW file to a tar archive; not that
55 ;;; important, but still...
56 ;;;
57 ;;; o In the directory listing, we don't show creation times because I don't
58 ;;; know how to print an arbitrary date, and I don't really want to have to
59 ;;; implement decode-universal-time.
60 ;;;
61 ;;; o The code is less efficient that it could be - in a lot of places, I
62 ;;; pull a 512-character string out of the buffer and parse it, when I could
63 ;;; be parsing it in place, not garbaging a string. Should redo that.
64 ;;;
65 ;;; o I'd like a command that searches for a string/regexp in every subfile
66 ;;; of an archive, where <esc> would leave you in a subfile-edit buffer.
67 ;;; (Like the Meta-R command of the Zmacs mail reader.)
68 ;;;
69 ;;; o Sometimes (but not always) reverting the tar-file buffer does not
70 ;;; re-grind the listing, and you are staring at the binary tar data.
71 ;;; Typing 'g' again immediately after that will always revert and re-grind
72 ;;; it, though. I have no idea why this happens.
73 ;;;
74 ;;; o Tar-mode interacts poorly with crypt.el and zcat.el because the tar
75 ;;; write-file-hook actually writes the file. Instead it should remove the
76 ;;; header (and conspire to put it back afterwards) so that other write-file
77 ;;; hooks which frob the buffer have a chance to do their dirty work. There
78 ;;; might be a problem if the tar write-file-hook does not come *first* on
79 ;;; the list.
80 ;;;
81 ;;; o Block files, sparse files, continuation files, and the various header
82 ;;; types aren't editable. Actually I don't know that they work at all.
83
84 ;;; Code:
85
86 (defvar tar-anal-blocksize 20
87 "*The blocksize of tar files written by Emacs, or nil, meaning don't care.
88 The blocksize of a tar file is not really the size of the blocks; rather, it is
89 the number of blocks written with one system call. When tarring to a tape,
90 this is the size of the *tape* blocks, but when writing to a file, it doesn't
91 matter much. The only noticeable difference is that if a tar file does not
92 have a blocksize of 20, tar will tell you that; all this really controls is
93 how many null padding bytes go on the end of the tar file.")
94
95 (defvar tar-update-datestamp nil
96 "*Whether tar-mode should play fast and loose with sub-file datestamps;
97 if this is true, then editing and saving a tar file entry back into its
98 tar file will update its datestamp. If false, the datestamp is unchanged.
99 You may or may not want this - it is good in that you can tell when a file
100 in a tar archive has been changed, but it is bad for the same reason that
101 editing a file in the tar archive at all is bad - the changed version of
102 the file never exists on disk.")
103
104 (defvar tar-parse-info nil)
105 (defvar tar-header-offset nil)
106 (defvar tar-superior-buffer nil)
107 (defvar tar-superior-descriptor nil)
108 (defvar tar-subfile-mode nil)
109
110 (put 'tar-parse-info 'permanent-local t)
111 (put 'tar-header-offset 'permanent-local t)
112 (put 'tar-superior-buffer 'permanent-local t)
113 (put 'tar-superior-descriptor 'permanent-local t)
114 \f
115 ;;; First, duplicate some Common Lisp functions; I used to just (require 'cl)
116 ;;; but "cl.el" was messing some people up (also it's really big).
117
118 (defmacro tar-setf (form val)
119 "A mind-numbingly simple implementation of setf."
120 (let ((mform (macroexpand form (and (boundp 'byte-compile-macro-environment)
121 byte-compile-macro-environment))))
122 (cond ((symbolp mform) (list 'setq mform val))
123 ((not (consp mform)) (error "can't setf %s" form))
124 ((eq (car mform) 'aref)
125 (list 'aset (nth 1 mform) (nth 2 mform) val))
126 ((eq (car mform) 'car)
127 (list 'setcar (nth 1 mform) val))
128 ((eq (car mform) 'cdr)
129 (list 'setcdr (nth 1 mform) val))
130 (t (error "don't know how to setf %s" form)))))
131
132 (defmacro tar-dolist (control &rest body)
133 "syntax: (dolist (var-name list-expr &optional return-value) &body body)"
134 (let ((var (car control))
135 (init (car (cdr control)))
136 (val (car (cdr (cdr control)))))
137 (list 'let (list (list '_dolist_iterator_ init))
138 (list 'while '_dolist_iterator_
139 (cons 'let
140 (cons (list (list var '(car _dolist_iterator_)))
141 (append body
142 (list (list 'setq '_dolist_iterator_
143 (list 'cdr '_dolist_iterator_)))))))
144 val)))
145
146 (defmacro tar-dotimes (control &rest body)
147 "syntax: (dolist (var-name count-expr &optional return-value) &body body)"
148 (let ((var (car control))
149 (n (car (cdr control)))
150 (val (car (cdr (cdr control)))))
151 (list 'let (list (list '_dotimes_end_ n)
152 (list var 0))
153 (cons 'while
154 (cons (list '< var '_dotimes_end_)
155 (append body
156 (list (list 'setq var (list '1+ var))))))
157 val)))
158
159 \f
160 ;;; down to business.
161
162 (defmacro make-tar-header (name mode uid git size date ck lt ln
163 magic uname gname devmaj devmin)
164 (list 'vector name mode uid git size date ck lt ln
165 magic uname gname devmaj devmin))
166
167 (defmacro tar-header-name (x) (list 'aref x 0))
168 (defmacro tar-header-mode (x) (list 'aref x 1))
169 (defmacro tar-header-uid (x) (list 'aref x 2))
170 (defmacro tar-header-gid (x) (list 'aref x 3))
171 (defmacro tar-header-size (x) (list 'aref x 4))
172 (defmacro tar-header-date (x) (list 'aref x 5))
173 (defmacro tar-header-checksum (x) (list 'aref x 6))
174 (defmacro tar-header-link-type (x) (list 'aref x 7))
175 (defmacro tar-header-link-name (x) (list 'aref x 8))
176 (defmacro tar-header-magic (x) (list 'aref x 9))
177 (defmacro tar-header-uname (x) (list 'aref x 10))
178 (defmacro tar-header-gname (x) (list 'aref x 11))
179 (defmacro tar-header-dmaj (x) (list 'aref x 12))
180 (defmacro tar-header-dmin (x) (list 'aref x 13))
181
182 (defmacro make-tar-desc (data-start tokens)
183 (list 'cons data-start tokens))
184
185 (defmacro tar-desc-data-start (x) (list 'car x))
186 (defmacro tar-desc-tokens (x) (list 'cdr x))
187
188 (defconst tar-name-offset 0)
189 (defconst tar-mode-offset (+ tar-name-offset 100))
190 (defconst tar-uid-offset (+ tar-mode-offset 8))
191 (defconst tar-gid-offset (+ tar-uid-offset 8))
192 (defconst tar-size-offset (+ tar-gid-offset 8))
193 (defconst tar-time-offset (+ tar-size-offset 12))
194 (defconst tar-chk-offset (+ tar-time-offset 12))
195 (defconst tar-linkp-offset (+ tar-chk-offset 8))
196 (defconst tar-link-offset (+ tar-linkp-offset 1))
197 ;;; GNU-tar specific slots.
198 (defconst tar-magic-offset (+ tar-link-offset 100))
199 (defconst tar-uname-offset (+ tar-magic-offset 8))
200 (defconst tar-gname-offset (+ tar-uname-offset 32))
201 (defconst tar-dmaj-offset (+ tar-gname-offset 32))
202 (defconst tar-dmin-offset (+ tar-dmaj-offset 8))
203 (defconst tar-end-offset (+ tar-dmin-offset 8))
204
205 (defun tokenize-tar-header-block (string)
206 "Return a `tar-header' structure.
207 This is a list of name, mode, uid, gid, size,
208 write-date, checksum, link-type, and link-name."
209 (cond ((< (length string) 512) nil)
210 (;(some 'plusp string) ; <-- oops, massive cycle hog!
211 (or (not (= 0 (aref string 0))) ; This will do.
212 (not (= 0 (aref string 101))))
213 (let* ((name-end (1- tar-mode-offset))
214 (link-end (1- tar-magic-offset))
215 (uname-end (1- tar-gname-offset))
216 (gname-end (1- tar-dmaj-offset))
217 (link-p (aref string tar-linkp-offset))
218 (magic-str (substring string tar-magic-offset (1- tar-uname-offset)))
219 (uname-valid-p (or (string= "ustar " magic-str) (string= "GNUtar " magic-str)))
220 name
221 (nulsexp "[^\000]*\000"))
222 (and (string-match nulsexp string tar-name-offset) (setq name-end (min name-end (1- (match-end 0)))))
223 (and (string-match nulsexp string tar-link-offset) (setq link-end (min link-end (1- (match-end 0)))))
224 (and (string-match nulsexp string tar-uname-offset) (setq uname-end (min uname-end (1- (match-end 0)))))
225 (and (string-match nulsexp string tar-gname-offset) (setq gname-end (min gname-end (1- (match-end 0)))))
226 (setq name (substring string tar-name-offset name-end)
227 link-p (if (or (= link-p 0) (= link-p ?0))
228 nil
229 (- link-p ?0)))
230 (if (and (null link-p) (string-match "/$" name)) (setq link-p 5)) ; directory
231 (make-tar-header
232 name
233 (tar-parse-octal-integer string tar-mode-offset (1- tar-uid-offset))
234 (tar-parse-octal-integer string tar-uid-offset (1- tar-gid-offset))
235 (tar-parse-octal-integer string tar-gid-offset (1- tar-size-offset))
236 (tar-parse-octal-integer string tar-size-offset (1- tar-time-offset))
237 (tar-parse-octal-integer string tar-time-offset (1- tar-chk-offset))
238 (tar-parse-octal-integer string tar-chk-offset (1- tar-linkp-offset))
239 link-p
240 (substring string tar-link-offset link-end)
241 uname-valid-p
242 (and uname-valid-p (substring string tar-uname-offset uname-end))
243 (and uname-valid-p (substring string tar-gname-offset gname-end))
244 (tar-parse-octal-integer string tar-dmaj-offset (1- tar-dmin-offset))
245 (tar-parse-octal-integer string tar-dmin-offset (1- tar-end-offset))
246 )))
247 (t 'empty-tar-block)))
248
249
250 (defun tar-parse-octal-integer (string &optional start end)
251 (if (null start) (setq start 0))
252 (if (null end) (setq end (length string)))
253 (if (= (aref string start) 0)
254 0
255 (let ((n 0))
256 (while (< start end)
257 (setq n (if (< (aref string start) ?0) n
258 (+ (* n 8) (- (aref string start) 48)))
259 start (1+ start)))
260 n)))
261
262 (defun tar-parse-octal-integer-safe (string)
263 (let ((L (length string)))
264 (if (= L 0) (error "empty string"))
265 (tar-dotimes (i L)
266 (if (or (< (aref string i) ?0)
267 (> (aref string i) ?7))
268 (error "'%c' is not an octal digit."))))
269 (tar-parse-octal-integer string))
270
271
272 (defun checksum-tar-header-block (string)
273 "Compute and return a tar-acceptable checksum for this block."
274 (let* ((chk-field-start tar-chk-offset)
275 (chk-field-end (+ chk-field-start 8))
276 (sum 0)
277 (i 0))
278 ;; Add up all of the characters except the ones in the checksum field.
279 ;; Add that field as if it were filled with spaces.
280 (while (< i chk-field-start)
281 (setq sum (+ sum (aref string i))
282 i (1+ i)))
283 (setq i chk-field-end)
284 (while (< i 512)
285 (setq sum (+ sum (aref string i))
286 i (1+ i)))
287 (+ sum (* 32 8))))
288
289 (defun check-tar-header-block-checksum (hblock desired-checksum file-name)
290 "Beep and print a warning if the checksum doesn't match."
291 (if (not (= desired-checksum (checksum-tar-header-block hblock)))
292 (progn (beep) (message "Invalid checksum for file %s!" file-name))))
293
294 (defun recompute-tar-header-block-checksum (hblock)
295 "Modifies the given string to have a valid checksum field."
296 (let* ((chk (checksum-tar-header-block hblock))
297 (chk-string (format "%6o" chk))
298 (l (length chk-string)))
299 (aset hblock 154 0)
300 (aset hblock 155 32)
301 (tar-dotimes (i l) (aset hblock (- 153 i) (aref chk-string (- l i 1)))))
302 hblock)
303
304
305 (defun tar-grind-file-mode (mode string start)
306 "Write a \"-rw--r--r-\" representing MODE into STRING beginning at START."
307 (aset string start (if (zerop (logand 256 mode)) ?- ?r))
308 (aset string (+ start 1) (if (zerop (logand 128 mode)) ?- ?w))
309 (aset string (+ start 2) (if (zerop (logand 64 mode)) ?- ?x))
310 (aset string (+ start 3) (if (zerop (logand 32 mode)) ?- ?r))
311 (aset string (+ start 4) (if (zerop (logand 16 mode)) ?- ?w))
312 (aset string (+ start 5) (if (zerop (logand 8 mode)) ?- ?x))
313 (aset string (+ start 6) (if (zerop (logand 4 mode)) ?- ?r))
314 (aset string (+ start 7) (if (zerop (logand 2 mode)) ?- ?w))
315 (aset string (+ start 8) (if (zerop (logand 1 mode)) ?- ?x))
316 (if (zerop (logand 1024 mode)) nil (aset string (+ start 2) ?s))
317 (if (zerop (logand 2048 mode)) nil (aset string (+ start 5) ?s))
318 string)
319
320 (defun summarize-tar-header-block (tar-hblock &optional mod-p)
321 "Returns a line similar to the output of `tar -vtf'."
322 (let ((name (tar-header-name tar-hblock))
323 (mode (tar-header-mode tar-hblock))
324 (uid (tar-header-uid tar-hblock))
325 (gid (tar-header-gid tar-hblock))
326 (uname (tar-header-uname tar-hblock))
327 (gname (tar-header-gname tar-hblock))
328 (size (tar-header-size tar-hblock))
329 (time (tar-header-date tar-hblock))
330 (ck (tar-header-checksum tar-hblock))
331 (link-p (tar-header-link-type tar-hblock))
332 (link-name (tar-header-link-name tar-hblock))
333 )
334 (let* ((left 11)
335 (namew 8)
336 (groupw 8)
337 (sizew 8)
338 (datew 2)
339 (slash (1- (+ left namew)))
340 (lastdigit (+ slash groupw sizew))
341 (namestart (+ lastdigit datew))
342 (string (make-string (+ namestart (length name) (if link-p (+ 5 (length link-name)) 0)) 32))
343 (type (tar-header-link-type tar-hblock)))
344 (aset string 0 (if mod-p ?* ? ))
345 (aset string 1
346 (cond ((or (eq type nil) (eq type 0)) ?-)
347 ((eq type 1) ?l) ; link
348 ((eq type 2) ?s) ; symlink
349 ((eq type 3) ?c) ; char special
350 ((eq type 4) ?b) ; block special
351 ((eq type 5) ?d) ; directory
352 ((eq type 6) ?p) ; FIFO/pipe
353 ((eq type 20) ?*) ; directory listing
354 ((eq type 29) ?M) ; multivolume continuation
355 ((eq type 35) ?S) ; sparse
356 ((eq type 38) ?V) ; volume header
357 ))
358 (tar-grind-file-mode mode string 2)
359 (setq uid (if (= 0 (length uname)) (int-to-string uid) uname))
360 (setq gid (if (= 0 (length gname)) (int-to-string gid) gname))
361 (setq size (int-to-string size))
362 (tar-dotimes (i (min (1- namew) (length uid))) (aset string (- slash i) (aref uid (- (length uid) i 1))))
363 (aset string (1+ slash) ?/)
364 (tar-dotimes (i (min (1- groupw) (length gid))) (aset string (+ (+ slash 2) i) (aref gid i)))
365 (tar-dotimes (i (min sizew (length size))) (aset string (- lastdigit i) (aref size (- (length size) i 1))))
366 ;; ## bloody hell, how do I print an arbitrary date??
367 (tar-dotimes (i (length name)) (aset string (+ namestart i) (aref name i)))
368 (if (or (eq link-p 1) (eq link-p 2))
369 (progn
370 (tar-dotimes (i 3) (aset string (+ namestart 1 (length name) i) (aref (if (= link-p 1) "==>" "-->") i)))
371 (tar-dotimes (i (length link-name)) (aset string (+ namestart 5 (length name) i) (aref link-name i)))))
372 string)))
373
374
375 (defun tar-summarize-buffer ()
376 "Parse the contents of the tar file in the current buffer.
377 Place a dired-like listing on the front;
378 then narrow to it, so that only that listing
379 is visible (and the real data of the buffer is hidden)."
380 (message "parsing tar file...")
381 (let* ((result '())
382 (pos 1)
383 (bs (max 1 (- (buffer-size) 1024))) ; always 2+ empty blocks at end.
384 (bs100 (max 1 (/ bs 100)))
385 (tokens nil))
386 (while (not (eq tokens 'empty-tar-block))
387 (let* ((hblock (buffer-substring pos (+ pos 512))))
388 (setq tokens (tokenize-tar-header-block hblock))
389 (setq pos (+ pos 512))
390 (message "parsing tar file...%s%%"
391 ;(/ (* pos 100) bs) ; this gets round-off lossage
392 (/ pos bs100) ; this doesn't
393 )
394 (if (eq tokens 'empty-tar-block)
395 nil
396 (if (null tokens) (error "premature EOF parsing tar file."))
397 (if (eq (tar-header-link-type tokens) 20)
398 ;; Foo. There's an extra empty block after these.
399 (setq pos (+ pos 512)))
400 (let ((size (tar-header-size tokens)))
401 (if (< size 0)
402 (error "%s has size %s - corrupted."
403 (tar-header-name tokens) size))
404 ;
405 ; This is just too slow. Don't really need it anyway....
406 ;(check-tar-header-block-checksum
407 ; hblock (checksum-tar-header-block hblock)
408 ; (tar-header-name tokens))
409
410 (setq result (cons (make-tar-desc pos tokens) result))
411
412 (if (and (null (tar-header-link-type tokens))
413 (> size 0))
414 (setq pos
415 (+ pos 512 (ash (ash (1- size) -9) 9)) ; this works
416 ;(+ pos (+ size (- 512 (rem (1- size) 512)))) ; this doesn't
417 ))
418 ))))
419 (make-local-variable 'tar-parse-info)
420 (setq tar-parse-info (nreverse result)))
421 (save-excursion
422 (goto-char (point-min))
423 (let ((buffer-read-only nil))
424 (tar-dolist (tar-desc tar-parse-info)
425 (insert-string
426 (summarize-tar-header-block (tar-desc-tokens tar-desc)))
427 (insert-string "\n"))
428 (make-local-variable 'tar-header-offset)
429 (setq tar-header-offset (point))
430 (narrow-to-region 1 tar-header-offset)
431 (set-buffer-modified-p nil)))
432 (message "parsing tar file...done."))
433 \f
434 (defvar tar-mode-map nil "*Local keymap for tar-mode listings.")
435
436 (if tar-mode-map
437 nil
438 (setq tar-mode-map (make-keymap))
439 (suppress-keymap tar-mode-map)
440 (define-key tar-mode-map " " 'tar-next-line)
441 (define-key tar-mode-map "c" 'tar-copy)
442 (define-key tar-mode-map "d" 'tar-flag-deleted)
443 (define-key tar-mode-map "\^D" 'tar-flag-deleted)
444 (define-key tar-mode-map "e" 'tar-extract)
445 (define-key tar-mode-map "f" 'tar-extract)
446 (define-key tar-mode-map "g" 'revert-buffer)
447 (define-key tar-mode-map "h" 'describe-mode)
448 (define-key tar-mode-map "n" 'tar-next-line)
449 (define-key tar-mode-map "\^N" 'tar-next-line)
450 (define-key tar-mode-map "o" 'tar-extract-other-window)
451 (define-key tar-mode-map "\^C" 'tar-copy)
452 (define-key tar-mode-map "p" 'tar-previous-line)
453 (define-key tar-mode-map "\^P" 'tar-previous-line)
454 (define-key tar-mode-map "r" 'tar-rename-entry)
455 (define-key tar-mode-map "u" 'tar-unflag)
456 (define-key tar-mode-map "v" 'tar-view)
457 (define-key tar-mode-map "x" 'tar-expunge)
458 (define-key tar-mode-map "\177" 'tar-unflag-backwards)
459 (define-key tar-mode-map "E" 'tar-extract-other-window)
460 (define-key tar-mode-map "M" 'tar-chmod-entry)
461 (define-key tar-mode-map "G" 'tar-chgrp-entry)
462 (define-key tar-mode-map "O" 'tar-chown-entry)
463 )
464 \f
465 ;; Make menu bar items.
466
467 ;; Get rid of the Edit menu bar item to save space.
468 (define-key tar-mode-map [menu-bar edit] 'undefined)
469
470 (define-key tar-mode-map [menu-bar immediate]
471 (cons "Immediate" (make-sparse-keymap "Immediate")))
472
473 (define-key tar-mode-map [menu-bar immediate view]
474 '("View This File" . tar-view))
475 (define-key tar-mode-map [menu-bar immediate display]
476 '("Display in Other Window" . tar-display-file))
477 (define-key tar-mode-map [menu-bar immediate find-file-other-window]
478 '("Find in Other Window" . tar-extract-other-window))
479 (define-key tar-mode-map [menu-bar immediate find-file]
480 '("Find This File" . tar-extract))
481
482 (define-key tar-mode-map [menu-bar mark]
483 (cons "Mark" (make-sparse-keymap "Mark")))
484
485 (define-key tar-mode-map [menu-bar mark unmark-all]
486 '("Unmark All" . tar-clear-modification-flags))
487 (define-key tar-mode-map [menu-bar mark deletion]
488 '("Flag" . tar-flag-deleted))
489 (define-key tar-mode-map [menu-bar mark unmark]
490 '("Unflag" . tar-unflag))
491
492 (define-key tar-mode-map [menu-bar operate]
493 (cons "Operate" (make-sparse-keymap "Operate")))
494
495 (define-key tar-mode-map [menu-bar operate chown]
496 '("Change Owner..." . tar-chown-entry))
497 (define-key tar-mode-map [menu-bar operate chgrp]
498 '("Change Group..." . tar-chgrp-entry))
499 (define-key tar-mode-map [menu-bar operate chmod]
500 '("Change Mode..." . tar-chmod-entry))
501 (define-key tar-mode-map [menu-bar operate rename]
502 '("Rename to..." . tar-rename-entry))
503 (define-key tar-mode-map [menu-bar operate copy]
504 '("Copy to..." . tar-copy))
505 (define-key tar-mode-map [menu-bar operate expunge]
506 '("Expunge marked files" . tar-expunge))
507 \f
508 ;; tar mode is suitable only for specially formatted data.
509 (put 'tar-mode 'mode-class 'special)
510 (put 'tar-subfile-mode 'mode-class 'special)
511
512 ;;;###autoload
513 (defun tar-mode ()
514 "Major mode for viewing a tar file as a dired-like listing of its contents.
515 You can move around using the usual cursor motion commands.
516 Letters no longer insert themselves.
517 Type `e' to pull a file out of the tar file and into its own buffer.
518 Type `c' to copy an entry from the tar file into another file on disk.
519
520 If you edit a sub-file of this archive (as with the `e' command) and
521 save it with Control-x Control-s, the contents of that buffer will be
522 saved back into the tar-file buffer; in this way you can edit a file
523 inside of a tar archive without extracting it and re-archiving it.
524
525 See also: variables `tar-update-datestamp' and `tar-anal-blocksize'.
526 \\{tar-mode-map}"
527 ;; this is not interactive because you shouldn't be turning this
528 ;; mode on and off. You can corrupt things that way.
529 ;; rms: with permanent locals, it should now be possible to make this work
530 ;; interactively in some reasonable fashion.
531 (kill-all-local-variables)
532 (make-local-variable 'tar-header-offset)
533 (make-local-variable 'tar-parse-info)
534 (make-local-variable 'require-final-newline)
535 (setq require-final-newline nil) ; binary data, dude...
536 (make-local-variable 'revert-buffer-function)
537 (setq revert-buffer-function 'tar-mode-revert)
538 (make-local-variable 'enable-local-variables)
539 (setq enable-local-variables nil)
540 (setq major-mode 'tar-mode)
541 (setq mode-name "Tar")
542 (use-local-map tar-mode-map)
543 (auto-save-mode 0)
544 (widen)
545 (if (and (boundp 'tar-header-offset) tar-header-offset)
546 (narrow-to-region 1 tar-header-offset)
547 (tar-summarize-buffer))
548 (run-hooks 'tar-mode-hook)
549 )
550
551
552 ;; This should be converted to use a minor mode keymap.
553
554 (defun tar-subfile-mode (p)
555 "Minor mode for editing an element of a tar-file.
556 This mode redefines C-x C-s to save the current buffer back into its
557 associated tar-file buffer. You must save that buffer to actually
558 save your changes to disk."
559 (interactive "P")
560 (or (and (boundp 'tar-superior-buffer) tar-superior-buffer)
561 (error "This buffer is not an element of a tar file"))
562 (or (assq 'tar-subfile-mode minor-mode-alist)
563 (setq minor-mode-alist (append minor-mode-alist
564 (list '(tar-subfile-mode
565 " TarFile")))))
566 (make-local-variable 'tar-subfile-mode)
567 (setq tar-subfile-mode
568 (if (null p)
569 (not tar-subfile-mode)
570 (> (prefix-numeric-value p) 0)))
571 (cond (tar-subfile-mode
572 (make-local-variable 'local-write-file-hooks)
573 (setq local-write-file-hooks '(tar-subfile-save-buffer))
574 ;; turn off auto-save.
575 (auto-save-mode nil)
576 (setq buffer-auto-save-file-name nil)
577 (run-hooks 'tar-subfile-mode-hook))
578 (t
579 (kill-local-variable 'local-write-file-hooks))))
580
581
582 ;; Revert the buffer and recompute the dired-like listing.
583 (defun tar-mode-revert (&optional no-autosave no-confirm)
584 (setq tar-header-offset nil)
585 (let ((revert-buffer-function nil))
586 (revert-buffer t no-confirm)
587 (widen))
588 (tar-mode))
589
590
591 (defun tar-next-line (p)
592 (interactive "p")
593 (forward-line p)
594 (if (eobp) nil (forward-char 36)))
595
596 (defun tar-previous-line (p)
597 (interactive "p")
598 (tar-next-line (- p)))
599
600 (defun tar-current-descriptor (&optional noerror)
601 "Return the tar-descriptor of the current line, or signals an error."
602 ;; I wish lines had plists, like in ZMACS...
603 (or (nth (count-lines (point-min)
604 (save-excursion (beginning-of-line) (point)))
605 tar-parse-info)
606 (if noerror
607 nil
608 (error "This line does not describe a tar-file entry."))))
609
610
611 (defun tar-extract (&optional other-window-p)
612 "*In Tar mode, extract this entry of the tar file into its own buffer."
613 (interactive)
614 (let* ((view-p (eq other-window-p 'view))
615 (descriptor (tar-current-descriptor))
616 (tokens (tar-desc-tokens descriptor))
617 (name (tar-header-name tokens))
618 (size (tar-header-size tokens))
619 (link-p (tar-header-link-type tokens))
620 (start (+ (tar-desc-data-start descriptor) tar-header-offset -1))
621 (end (+ start size)))
622 (if link-p
623 (error "This is a %s, not a real file."
624 (cond ((eq link-p 5) "directory")
625 ((eq link-p 20) "tar directory header")
626 ((eq link-p 29) "multivolume-continuation")
627 ((eq link-p 35) "sparse entry")
628 ((eq link-p 38) "volume header")
629 (t "link"))))
630 (if (zerop size) (error "This is a zero-length file."))
631 (let* ((tar-buffer (current-buffer))
632 (bufname (concat (file-name-nondirectory name)
633 " (" name " in "
634 (file-name-nondirectory (buffer-file-name))
635 ")"))
636 (read-only-p (or buffer-read-only view-p))
637 (buffer (get-buffer bufname))
638 (just-created nil))
639 (if buffer
640 nil
641 (setq buffer (get-buffer-create bufname))
642 (setq just-created t)
643 (unwind-protect
644 (progn
645 (widen)
646 (save-excursion
647 (set-buffer buffer)
648 (insert-buffer-substring tar-buffer start end)
649 (goto-char 0)
650 (set-visited-file-name name) ; give it a name to decide mode.
651 (normal-mode) ; pick a mode.
652 (set-visited-file-name nil) ; nuke the name - not meaningful.
653 (rename-buffer bufname)
654
655 (make-local-variable 'tar-superior-buffer)
656 (make-local-variable 'tar-superior-descriptor)
657 (setq tar-superior-buffer tar-buffer)
658 (setq tar-superior-descriptor descriptor)
659 (tar-subfile-mode 1)
660
661 (setq buffer-read-only read-only-p)
662 (set-buffer-modified-p nil))
663 (set-buffer tar-buffer))
664 (narrow-to-region 1 tar-header-offset)))
665 (if view-p
666 (progn
667 (view-buffer buffer)
668 (and just-created
669 (setq view-exit-action 'kill-buffer)))
670 (if (eq other-window-p 'display)
671 (display-buffer buffer)
672 (if other-window-p
673 (switch-to-buffer-other-window buffer)
674 (switch-to-buffer buffer)))))))
675
676
677 (defun tar-extract-other-window ()
678 "*In Tar mode, find this entry of the tar file in another window."
679 (interactive)
680 (tar-extract t))
681
682 (defun tar-display-other-window ()
683 "*In Tar mode, display this entry of the tar file in another window."
684 (interactive)
685 (tar-extract 'display))
686
687 (defun tar-view ()
688 "*In Tar mode, view the tar file entry on this line."
689 (interactive)
690 (tar-extract 'view))
691
692
693 (defun tar-read-file-name (&optional prompt)
694 "Read a file name with this line's entry as the default."
695 (or prompt (setq prompt "Copy to: "))
696 (let* ((default-file (expand-file-name
697 (tar-header-name (tar-desc-tokens
698 (tar-current-descriptor)))))
699 (target (expand-file-name
700 (read-file-name prompt
701 (file-name-directory default-file)
702 default-file nil))))
703 (if (or (string= "" (file-name-nondirectory target))
704 (file-directory-p target))
705 (setq target (concat (if (string-match "/$" target)
706 (substring target 0 (1- (match-end 0)))
707 target)
708 "/"
709 (file-name-nondirectory default-file))))
710 target))
711
712
713 (defun tar-copy (&optional to-file)
714 "*In Tar mode, extract this entry of the tar file into a file on disk.
715 If TO-FILE is not supplied, it is prompted for, defaulting to the name of
716 the current tar-entry."
717 (interactive (list (tar-read-file-name)))
718 (let* ((descriptor (tar-current-descriptor))
719 (tokens (tar-desc-tokens descriptor))
720 (name (tar-header-name tokens))
721 (size (tar-header-size tokens))
722 (link-p (tar-header-link-type tokens))
723 (start (+ (tar-desc-data-start descriptor) tar-header-offset -1))
724 (end (+ start size)))
725 (if link-p (error "This is a link, not a real file."))
726 (if (zerop size) (error "This is a zero-length file."))
727 (let* ((tar-buffer (current-buffer))
728 buffer)
729 (unwind-protect
730 (progn
731 (setq buffer (generate-new-buffer "*tar-copy-tmp*"))
732 (widen)
733 (save-excursion
734 (set-buffer buffer)
735 (insert-buffer-substring tar-buffer start end)
736 (set-buffer-modified-p nil) ; in case we abort
737 (write-file to-file)
738 (message "Copied tar entry %s to %s" name to-file)
739 (set-buffer tar-buffer)))
740 (narrow-to-region 1 tar-header-offset)
741 (if buffer (kill-buffer buffer)))
742 )))
743
744
745 (defun tar-flag-deleted (p &optional unflag)
746 "*In Tar mode, mark this sub-file to be deleted from the tar file.
747 With a prefix argument, mark that many files."
748 (interactive "p")
749 (beginning-of-line)
750 (tar-dotimes (i (if (< p 0) (- p) p))
751 (if (tar-current-descriptor unflag) ; barf if we're not on an entry-line.
752 (progn
753 (delete-char 1)
754 (insert (if unflag " " "D"))))
755 (forward-line (if (< p 0) -1 1)))
756 (if (eobp) nil (forward-char 36)))
757
758 (defun tar-unflag (p)
759 "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
760 With a prefix argument, un-mark that many files forward."
761 (interactive "p")
762 (tar-flag-deleted p t))
763
764 (defun tar-unflag-backwards (p)
765 "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
766 With a prefix argument, un-mark that many files backward."
767 (interactive "p")
768 (tar-flag-deleted (- p) t))
769
770
771 (defun tar-expunge-internal ()
772 "Expunge the tar-entry specified by the current line."
773 (let* ((descriptor (tar-current-descriptor))
774 (tokens (tar-desc-tokens descriptor))
775 (line (tar-desc-data-start descriptor))
776 (name (tar-header-name tokens))
777 (size (tar-header-size tokens))
778 (link-p (tar-header-link-type tokens))
779 (start (tar-desc-data-start descriptor))
780 (following-descs (cdr (memq descriptor tar-parse-info))))
781 (if link-p (setq size 0)) ; size lies for hard-links.
782 ;;
783 ;; delete the current line...
784 (beginning-of-line)
785 (let ((line-start (point)))
786 (end-of-line) (forward-char)
787 (let ((line-len (- (point) line-start)))
788 (delete-region line-start (point))
789 ;;
790 ;; decrement the header-pointer to be in synch...
791 (setq tar-header-offset (- tar-header-offset line-len))))
792 ;;
793 ;; delete the data pointer...
794 (setq tar-parse-info (delq descriptor tar-parse-info))
795 ;;
796 ;; delete the data from inside the file...
797 (widen)
798 (let* ((data-start (+ start tar-header-offset -513))
799 (data-end (+ data-start 512 (ash (ash (+ size 511) -9) 9))))
800 (delete-region data-start data-end)
801 ;;
802 ;; and finally, decrement the start-pointers of all following
803 ;; entries in the archive. This is a pig when deleting a bunch
804 ;; of files at once - we could optimize this to only do the
805 ;; iteration over the files that remain, or only iterate up to
806 ;; the next file to be deleted.
807 (let ((data-length (- data-end data-start)))
808 (tar-dolist (desc following-descs)
809 (tar-setf (tar-desc-data-start desc)
810 (- (tar-desc-data-start desc) data-length))))
811 ))
812 (narrow-to-region 1 tar-header-offset))
813
814
815 (defun tar-expunge (&optional noconfirm)
816 "*In Tar mode, delete all the archived files flagged for deletion.
817 This does not modify the disk image; you must save the tar file itself
818 for this to be permanent."
819 (interactive)
820 (if (or noconfirm
821 (y-or-n-p "expunge files marked for deletion? "))
822 (let ((n 0))
823 (save-excursion
824 (goto-char 0)
825 (while (not (eobp))
826 (if (looking-at "D")
827 (progn (tar-expunge-internal)
828 (setq n (1+ n)))
829 (forward-line 1)))
830 ;; after doing the deletions, add any padding that may be necessary.
831 (tar-pad-to-blocksize)
832 (narrow-to-region 1 tar-header-offset)
833 )
834 (if (zerop n)
835 (message "nothing to expunge.")
836 (message "%s expunged. Be sure to save this buffer." n)))))
837
838
839 (defun tar-clear-modification-flags ()
840 "Remove the stars at the beginning of each line."
841 (save-excursion
842 (goto-char 0)
843 (while (< (point) tar-header-offset)
844 (if (looking-at "*")
845 (progn (delete-char 1) (insert " ")))
846 (forward-line 1))))
847
848
849 (defun tar-chown-entry (new-uid)
850 "*Change the user-id associated with this entry in the tar file.
851 If this tar file was written by GNU tar, then you will be able to edit
852 the user id as a string; otherwise, you must edit it as a number.
853 You can force editing as a number by calling this with a prefix arg.
854 This does not modify the disk image; you must save the tar file itself
855 for this to be permanent."
856 (interactive (list
857 (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
858 (if (or current-prefix-arg
859 (not (tar-header-magic tokens)))
860 (let (n)
861 (while (not (numberp (setq n (read-minibuffer
862 "New UID number: "
863 (format "%s" (tar-header-uid tokens)))))))
864 n)
865 (read-string "New UID string: " (tar-header-uname tokens))))))
866 (cond ((stringp new-uid)
867 (tar-setf (tar-header-uname (tar-desc-tokens (tar-current-descriptor)))
868 new-uid)
869 (tar-alter-one-field tar-uname-offset (concat new-uid "\000")))
870 (t
871 (tar-setf (tar-header-uid (tar-desc-tokens (tar-current-descriptor)))
872 new-uid)
873 (tar-alter-one-field tar-uid-offset
874 (concat (substring (format "%6o" new-uid) 0 6) "\000 ")))))
875
876
877 (defun tar-chgrp-entry (new-gid)
878 "*Change the group-id associated with this entry in the tar file.
879 If this tar file was written by GNU tar, then you will be able to edit
880 the group id as a string; otherwise, you must edit it as a number.
881 You can force editing as a number by calling this with a prefix arg.
882 This does not modify the disk image; you must save the tar file itself
883 for this to be permanent."
884 (interactive (list
885 (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
886 (if (or current-prefix-arg
887 (not (tar-header-magic tokens)))
888 (let (n)
889 (while (not (numberp (setq n (read-minibuffer
890 "New GID number: "
891 (format "%s" (tar-header-gid tokens)))))))
892 n)
893 (read-string "New GID string: " (tar-header-gname tokens))))))
894 (cond ((stringp new-gid)
895 (tar-setf (tar-header-gname (tar-desc-tokens (tar-current-descriptor)))
896 new-gid)
897 (tar-alter-one-field tar-gname-offset
898 (concat new-gid "\000")))
899 (t
900 (tar-setf (tar-header-gid (tar-desc-tokens (tar-current-descriptor)))
901 new-gid)
902 (tar-alter-one-field tar-gid-offset
903 (concat (substring (format "%6o" new-gid) 0 6) "\000 ")))))
904
905 (defun tar-rename-entry (new-name)
906 "*Change the name associated with this entry in the tar file.
907 This does not modify the disk image; you must save the tar file itself
908 for this to be permanent."
909 (interactive
910 (list (read-string "New name: "
911 (tar-header-name (tar-desc-tokens (tar-current-descriptor))))))
912 (if (string= "" new-name) (error "zero length name."))
913 (if (> (length new-name) 98) (error "name too long."))
914 (tar-setf (tar-header-name (tar-desc-tokens (tar-current-descriptor)))
915 new-name)
916 (tar-alter-one-field 0
917 (substring (concat new-name (make-string 99 0)) 0 99)))
918
919
920 (defun tar-chmod-entry (new-mode)
921 "*Change the protection bits associated with this entry in the tar file.
922 This does not modify the disk image; you must save the tar file itself
923 for this to be permanent."
924 (interactive (list (tar-parse-octal-integer-safe
925 (read-string "New protection (octal): "))))
926 (tar-setf (tar-header-mode (tar-desc-tokens (tar-current-descriptor)))
927 new-mode)
928 (tar-alter-one-field tar-mode-offset
929 (concat (substring (format "%6o" new-mode) 0 6) "\000 ")))
930
931
932 (defun tar-alter-one-field (data-position new-data-string)
933 (let* ((descriptor (tar-current-descriptor))
934 (tokens (tar-desc-tokens descriptor)))
935 (unwind-protect
936 (save-excursion
937 ;;
938 ;; update the header-line.
939 (beginning-of-line)
940 (let ((p (point)))
941 (forward-line 1)
942 (delete-region p (point))
943 (insert (summarize-tar-header-block tokens) "\n")
944 (setq tar-header-offset (point-max)))
945
946 (widen)
947 (let* ((start (+ (tar-desc-data-start descriptor) tar-header-offset -513)))
948 ;;
949 ;; delete the old field and insert a new one.
950 (goto-char (+ start data-position))
951 (delete-region (point) (+ (point) (length new-data-string))) ; <--
952 (insert new-data-string) ; <--
953 ;;
954 ;; compute a new checksum and insert it.
955 (let ((chk (checksum-tar-header-block
956 (buffer-substring start (+ start 512)))))
957 (goto-char (+ start tar-chk-offset))
958 (delete-region (point) (+ (point) 8))
959 (insert (format "%6o" chk))
960 (insert 0)
961 (insert ? )
962 (tar-setf (tar-header-checksum tokens) chk)
963 ;;
964 ;; ok, make sure we didn't botch it.
965 (check-tar-header-block-checksum
966 (buffer-substring start (+ start 512))
967 chk (tar-header-name tokens))
968 )))
969 (narrow-to-region 1 tar-header-offset))))
970
971
972 (defun tar-octal-time (timeval)
973 ;; Format a timestamp as 11 octal digits. Ghod, I hope this works...
974 (let ((hibits (car timeval)) (lobits (car (cdr timeval))))
975 (insert (format "%05o%01o%05o"
976 (lsh hibits -2)
977 (logior (lsh (logand 3 hibits) 1) (> (logand lobits 32768) 0))
978 (logand 32767 lobits)
979 ))))
980
981 (defun tar-subfile-save-buffer ()
982 "In tar subfile mode, save this buffer into its parent tar-file buffer.
983 This doesn't write anything to disk; you must save the parent tar-file buffer
984 to make your changes permanent."
985 (interactive)
986 (if (not (and (boundp 'tar-superior-buffer) tar-superior-buffer))
987 (error "this buffer has no superior tar file buffer."))
988 (if (not (and (boundp 'tar-superior-descriptor) tar-superior-descriptor))
989 (error "this buffer doesn't have an index into its superior tar file!"))
990 (save-excursion
991 (let ((subfile (current-buffer))
992 (subfile-size (buffer-size))
993 (descriptor tar-superior-descriptor))
994 (set-buffer tar-superior-buffer)
995 (let* ((tokens (tar-desc-tokens descriptor))
996 (start (tar-desc-data-start descriptor))
997 (name (tar-header-name tokens))
998 (size (tar-header-size tokens))
999 (size-pad (ash (ash (+ size 511) -9) 9))
1000 (head (memq descriptor tar-parse-info))
1001 (following-descs (cdr head)))
1002 (if (not head)
1003 (error "Can't find this tar file entry in its parent tar file!"))
1004 (unwind-protect
1005 (save-excursion
1006 (widen)
1007 ;; delete the old data...
1008 (let* ((data-start (+ start tar-header-offset -1))
1009 (data-end (+ data-start (ash (ash (+ size 511) -9) 9))))
1010 (delete-region data-start data-end)
1011 ;; insert the new data...
1012 (goto-char data-start)
1013 (insert-buffer subfile)
1014 ;;
1015 ;; pad the new data out to a multiple of 512...
1016 (let ((subfile-size-pad (ash (ash (+ subfile-size 511) -9) 9)))
1017 (goto-char (+ data-start subfile-size))
1018 (insert (make-string (- subfile-size-pad subfile-size) 0))
1019 ;;
1020 ;; update the data pointer of this and all following files...
1021 (tar-setf (tar-header-size tokens) subfile-size)
1022 (let ((difference (- subfile-size-pad size-pad)))
1023 (tar-dolist (desc following-descs)
1024 (tar-setf (tar-desc-data-start desc)
1025 (+ (tar-desc-data-start desc) difference))))
1026 ;;
1027 ;; Update the size field in the header block.
1028 (let ((header-start (- data-start 512)))
1029 (goto-char (+ header-start tar-size-offset))
1030 (delete-region (point) (+ (point) 12))
1031 (insert (format "%11o" subfile-size))
1032 (insert ? )
1033 ;;
1034 ;; Maybe update the datestamp.
1035 (if (not tar-update-datestamp)
1036 nil
1037 (goto-char (+ header-start tar-time-offset))
1038 (delete-region (point) (+ (point) 12))
1039 (insert (tar-octal-time (current-time)))
1040 (insert ? ))
1041 ;;
1042 ;; compute a new checksum and insert it.
1043 (let ((chk (checksum-tar-header-block
1044 (buffer-substring header-start data-start))))
1045 (goto-char (+ header-start tar-chk-offset))
1046 (delete-region (point) (+ (point) 8))
1047 (insert (format "%6o" chk))
1048 (insert 0)
1049 (insert ? )
1050 (tar-setf (tar-header-checksum tokens) chk)))
1051 ;;
1052 ;; alter the descriptor-line...
1053 ;;
1054 (let ((position (- (length tar-parse-info) (length head))))
1055 (goto-char 1)
1056 (next-line position)
1057 (beginning-of-line)
1058 (let ((p (point))
1059 (m (set-marker (make-marker) tar-header-offset)))
1060 (forward-line 1)
1061 (delete-region p (point))
1062 (insert-before-markers (summarize-tar-header-block tokens t) "\n")
1063 (setq tar-header-offset (marker-position m)))
1064 )))
1065 ;; after doing the insertion, add any final padding that may be necessary.
1066 (tar-pad-to-blocksize))
1067 (narrow-to-region 1 tar-header-offset)))
1068 (set-buffer-modified-p t) ; mark the tar file as modified
1069 (set-buffer subfile)
1070 (set-buffer-modified-p nil) ; mark the tar subfile as unmodified
1071 (message "saved into tar-buffer \"%s\" - remember to save that buffer!"
1072 (buffer-name tar-superior-buffer))
1073 ;; Prevent ordinary saving from happening.
1074 t)))
1075
1076
1077 (defun tar-pad-to-blocksize ()
1078 "If we are being anal about tar file blocksizes, fix up the current buffer.
1079 Leaves the region wide."
1080 (if (null tar-anal-blocksize)
1081 nil
1082 (widen)
1083 (let* ((last-desc (nth (1- (length tar-parse-info)) tar-parse-info))
1084 (start (tar-desc-data-start last-desc))
1085 (tokens (tar-desc-tokens last-desc))
1086 (link-p (tar-header-link-type tokens))
1087 (size (if link-p 0 (tar-header-size tokens)))
1088 (data-end (+ start size))
1089 (bbytes (ash tar-anal-blocksize 9))
1090 (pad-to (+ bbytes (* bbytes (/ (1- data-end) bbytes))))
1091 (buffer-read-only nil) ; ##
1092 )
1093 ;; If the padding after the last data is too long, delete some;
1094 ;; else insert some until we are padded out to the right number of blocks.
1095 ;;
1096 (goto-char (+ (or tar-header-offset 0) data-end))
1097 (if (> (1+ (buffer-size)) (+ (or tar-header-offset 0) pad-to))
1098 (delete-region (+ (or tar-header-offset 0) pad-to) (1+ (buffer-size)))
1099 (insert (make-string (- (+ (or tar-header-offset 0) pad-to)
1100 (1+ (buffer-size)))
1101 0)))
1102 )))
1103
1104
1105 (defun maybe-write-tar-file ()
1106 "Used as a write-file-hook to write tar-files out correctly."
1107 ;;
1108 ;; If the current buffer is in Tar mode and has its header-offset set,
1109 ;; only write out the part of the file after the header-offset.
1110 ;;
1111 (if (and (eq major-mode 'tar-mode)
1112 (and (boundp 'tar-header-offset) tar-header-offset))
1113 (unwind-protect
1114 (save-excursion
1115 (tar-clear-modification-flags)
1116 (widen)
1117 ;; Doing this here confuses things - the region gets left too wide!
1118 ;; I suppose this is run in a context where changing the buffer is bad.
1119 ;; (tar-pad-to-blocksize)
1120 (write-region tar-header-offset (1+ (buffer-size)) buffer-file-name nil t)
1121 ;; return T because we've written the file.
1122 t)
1123 (narrow-to-region 1 tar-header-offset)
1124 t)
1125 ;; return NIL because we haven't.
1126 nil))
1127
1128 \f
1129 ;;; Patch it in.
1130
1131 (or (memq 'maybe-write-tar-file write-file-hooks)
1132 (setq write-file-hooks
1133 (cons 'maybe-write-tar-file write-file-hooks)))
1134
1135 (provide 'tar-mode)
1136
1137 ;;; tar-mode.el ends here