home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / functions / live-find-file.el < prev    next >
Encoding:
Text File  |  1991-07-03  |  7.2 KB  |  203 lines
  1. ; Path: dg-rtp!rock!mcnc!stanford.edu!agate!spool.mu.edu!caen!zaphod.mps.ohio-state.edu!cis.ohio-state.edu!csvax.cs.caltech.edu!daveg
  2. ; From: daveg@csvax.cs.caltech.edu (David Gillespie)
  3. ; Newsgroups: gnu.emacs.sources
  4. ; Subject: A live-find-file command
  5. ; Date: 29 Jun 91 11:25:57 GMT
  6. ; Organization: Source only  Discussion and requests in gnu.emacs.help.
  7. ; 
  8. ; This file defines a simple command for monitoring files that grow, such as
  9. ; log files.  Type M-x live-find-file RET and enter the file name; the result
  10. ; will be a read-only buffer with a Unix "tail -f" command living in it that
  11. ; keeps the buffer up-to-date as the file grows.
  12. ; 
  13. ; If you switch away from the buffer and new input arrives, Emacs notifies you
  14. ; of this in the echo area.  The `n' key selects a few other notification modes.
  15. ; 
  16. ; When you are done with the buffer, just kill it with `q' or `C-x k' and the
  17. ; "tail -f" command will go away.
  18. ; 
  19. ; Enjoy,
  20. ;                                 -- Dave
  21. ; 
  22. ; 
  23. ;; View a file with "live" updates as the file grows on disk.
  24. ;; Copyright (C) 1991 Dave Gillespie
  25.  
  26. ;; LCD Archive Entry:
  27. ;; live-find-file|David Gillespie|daveg@csvax.cs.caltech.edu
  28. ;; |View a file with "live" updates as the file grows on disk
  29. ;; |91-06-29||~/functions/live-find-file.el.Z
  30.  
  31. ;; This file is part of GNU Emacs.
  32.  
  33. ;; GNU Emacs is distributed in the hope that it will be useful,
  34. ;; but WITHOUT ANY WARRANTY.  No author or distributor
  35. ;; accepts responsibility to anyone for the consequences of using it
  36. ;; or for whether it serves any particular purpose or works at all,
  37. ;; unless he says so in writing.  Refer to the GNU Emacs General Public
  38. ;; License for full details.
  39.  
  40. ;; Everyone is granted permission to copy, modify and redistribute
  41. ;; GNU Emacs, but only under the conditions described in the
  42. ;; GNU Emacs General Public License.   A copy of this license is
  43. ;; supposed to have been given to you along with GNU Emacs so you
  44. ;; can know your rights and responsibilities.  It should be in a
  45. ;; file named COPYING.  Among other things, the copyright notice
  46. ;; and this notice must be preserved on all copies.
  47.  
  48. ;; Usage:
  49. ;;   (autoload 'live-find-file "live" "View a file with \"tail -f\"" t)
  50. ;;   M-x live-find-file RET filename RET
  51.  
  52.  
  53. (defvar live-file-notify t
  54.   "*Non-nil to display a message in the echo area if data comes in on a
  55. live file buffer which is not currently displayed.
  56. If Non-nil and not \"t\", actually display the buffer if new data comes in.")
  57.  
  58. (defvar live-file-mask (concat "^\000\001\002\003\004\005\006\007\010\011"
  59.                    "\013\015\016\017\020\021\022\023\024\025"
  60.                    "\026\027\030\031\032\033\034\035\036\037\177")
  61.   "*A string of characters to retain in a live file buffer;
  62. all others are discarded.  If it begins with \"^\", it is a list of
  63. characters which *should* be discarded.
  64. Default is to discard all control characters except new-line and form-feed.")
  65.  
  66.  
  67.  
  68. (defun live-find-file (filename)
  69.   "Read in and display a file with \"live\" updates as the file grows on disk.
  70. This is accomplished using the Unix \"tail -f\" command.
  71. The buffer will remain live until you kill it with \\[kill-buffer].
  72. The buffer is made read-only, and should probably be left that way.
  73. Inside the buffer, hit n to change notification mode, r to re-read, q to kill."
  74.   (interactive "fLive find file: ")
  75.   (setq filename (expand-file-name filename))
  76.   (if (file-directory-p filename)
  77.       (error "%s is a directory." filename))
  78.   (let ((buf (create-file-buffer filename))
  79.     size)
  80.     (switch-to-buffer buf)
  81.     (fundamental-mode)
  82.     (setq major-mode 'live-find-file)
  83.     (setq mode-name "Live-Find-File")
  84.     (use-local-map (make-sparse-keymap))   ; should set up a real major mode!
  85.     (local-set-key "q" "\C-xk\r")
  86.     (local-set-key "n" 'Live-file-notify)
  87.     (local-set-key "r" 'Live-file-reread)
  88.     (local-set-key " " 'scroll-up)
  89.     (local-set-key "\177" 'scroll-down)
  90.     (local-set-key "?" 'Live-file-help)
  91.     (local-set-key "h" 'Live-file-help)
  92.     (erase-buffer)
  93.     (insert-file-contents filename t)
  94.     (setq size (buffer-size))
  95.     (live-file-clean-region (point-min) (point-max))
  96.     (set-buffer-modified-p nil)
  97.     (setq buffer-read-only t)
  98.     (goto-char (point-max))
  99.     (setq default-directory (file-name-directory filename))
  100.     (let* ((process-connection-type nil)
  101.        (proc (start-process
  102.           "tail" (current-buffer) "tail"
  103.           (format "+%dcf" (1+ size))
  104.           filename)))
  105.       (process-kill-without-query proc)
  106.       (set-process-filter proc 'live-file-filter)))
  107. )
  108.  
  109. (defun Live-file-help ()
  110.   (interactive)
  111.   (message "Live mode:  n=change notification method, q=quit, r=reread")
  112. )
  113.  
  114. (defun Live-file-notify (flag)
  115.   "Control whether to notify on input from live files not visible in a window.
  116. This applies to files created by \\[live-find-file].
  117. Cycles among three options:  Notify in echo area, notify by creating a new
  118. window, or don't notify.
  119. Notification mode applies if input arrives for a live file that is not
  120. currently visible.  If input arrives for a live file that is visible but
  121. that has been scrolled so that the end is not visible, new input always
  122. notifies in the echo area."
  123.   (interactive "P")
  124.   (setq live-file-notify
  125.     (cond ((null flag)
  126.            (or (not live-file-notify)
  127.            (and (eq live-file-notify t)
  128.             'show)))
  129.           ((not (integerp flag)) 'show)
  130.           ((> flag 0) t)))
  131.   (message (cond ((eq live-file-notify t) "Notifying in echo area.")
  132.          (live-file-notify "Notifying in a new window.")
  133.          (t "Not notifying.")))
  134. )
  135.  
  136. (defun Live-file-reread ()
  137.   "Re-read the contents of the current live file from disk.
  138. Live-find-file only checks for new text being appended at the end.  This
  139. command re-reads the whole of the file to see if any of it has changed."
  140.   (interactive)
  141.   (let ((name (buffer-file-name)))
  142.     (or name
  143.     (error "Buffer is not visiting a file."))
  144.     (or (file-readable-p name)
  145.     (error "File %s no longer exists." name))
  146.     (message "Re-reading %s..." name)
  147.     (kill-buffer (current-buffer))
  148.     (live-find-file name)
  149.     (message "Re-reading %s...done" name))
  150. )
  151.  
  152. (defun live-file-filter (proc str)
  153.   (let* ((oldbuf (current-buffer))
  154.      (buf (process-buffer proc))
  155.      (win (get-buffer-window buf))
  156.      (changed nil))
  157.     (unwind-protect
  158.     (progn
  159.       (set-buffer buf)
  160.       (clear-visited-file-modtime)
  161.       (let ((pt (point-max))
  162.         (opt (and (< (point) (point-max)) (point)))
  163.         (mod (buffer-modified-p)))
  164.         (goto-char pt)
  165.         (let ((buffer-read-only nil))
  166.           (insert str)
  167.           (live-file-clean-region pt (point-max)))
  168.         (setq changed (/= pt (point-max)))
  169.         (and changed
  170.          (or (not win)
  171.              (not (pos-visible-in-window-p pt win)))
  172.          (or win (eq live-file-notify t))
  173.          (= (minibuffer-depth) 0)
  174.          (message "From %s: %s"
  175.               (file-name-nondirectory
  176.                (buffer-file-name buf))
  177.               str))
  178.         (or mod
  179.         (set-buffer-modified-p nil))
  180.         (or opt (setq opt (point-max)))
  181.         (goto-char opt)
  182.         (and win (set-window-point win opt))))
  183.       (set-buffer oldbuf))
  184.     (and changed
  185.      live-file-notify 
  186.      (not (eq live-file-notify t))
  187.      (not (get-buffer-window buf))
  188.      (set-window-point (display-buffer buf t)
  189.                (save-excursion (set-buffer buf)
  190.                        (goto-char (point-max))
  191.                        (point)))))
  192. )
  193.  
  194. (defun live-file-clean-region (start end)
  195.   (and live-file-mask
  196.        (save-excursion
  197.      (goto-char end)
  198.      (while (progn
  199.           (skip-chars-backward live-file-mask start)
  200.           (> (point) start))
  201.        (delete-backward-char 1))))
  202. )
  203.