lisp/log-view.el

   1 ;;; log-view.el --- Major mode for browsing RCS/CVS/SCCS log output
   2
   3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005,
   4 ;;   2006, 2007 Free Software Foundation, Inc.
   5
   6 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
   7 ;; Keywords: rcs sccs cvs log version-control
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 3, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; Major mode to browse revision log histories.
  29 ;; Currently supports the format output by:
  30 ;;  RCS, SCCS, CVS, Subversion, and DaRCS.
  31
  32 ;; Examples of log output:
  33
  34 ;;;; RCS/CVS:
  35
  36 ;; ----------------------------
  37 ;; revision 1.35        locked by: turlutut
  38 ;; date: 2005-03-22 18:48:38 +0000;  author: monnier;  state: Exp;  lines: +6 -8
  39 ;; (gnus-display-time-event-handler):
  40 ;; Check display-time-timer at runtime rather than only at load time
  41 ;; in case display-time-mode is turned off in the mean time.
  42 ;; ----------------------------
  43 ;; revision 1.34
  44 ;; date: 2005-02-09 15:50:38 +0000;  author: kfstorm;  state: Exp;  lines: +7 -7
  45 ;; branches:  1.34.2;
  46 ;; Change release version from 21.4 to 22.1 throughout.
  47 ;; Change development version from 21.3.50 to 22.0.50.
  48
  49 ;;;; SCCS:
  50
  51 ;;;; Subversion:
  52
  53 ;;;; Darcs:
  54
  55 ;; Changes to darcsum.el:
  56 ;;
  57 ;; Mon Nov 28 15:19:38 GMT 2005  Dave Love <fx@gnu.org>
  58 ;;   * Abstract process startup into darcsum-start-process.  Use TERM=dumb.
  59 ;;   TERM=dumb avoids escape characters, at least, for any old darcs that
  60 ;;   doesn't understand DARCS_DONT_COLOR & al.
  61 ;;
  62 ;; Thu Nov 24 15:20:45 GMT 2005  Dave Love <fx@gnu.org>
  63 ;;   * darcsum-mode-related changes.
  64 ;;   Don't call font-lock-mode (unnecessary) or use-local-map (redundant).
  65 ;;   Use mode-class 'special.  Add :group.
  66 ;;   Add trailing-whitespace option to mode hook and fix
  67 ;;   darcsum-display-changeset not to use trailing whitespace.
  68
  69 ;;; Todo:
  70
  71 ;; - add ability to modify a log-entry (via cvs-mode-admin ;-)
  72 ;; - remove references to cvs-*
  73 ;; - make it easier to add support for new backends without changing the code.
  74
  75 ;;; Code:
  76
  77 (eval-when-compile (require 'cl))
  78 (require 'pcvs-util)
  79 (autoload 'vc-find-version "vc")
  80 (autoload 'vc-version-diff "vc")
  81
  82 (defvar cvs-minor-wrap-function)
  83
  84 (defgroup log-view nil
  85   "Major mode for browsing log output of RCS/CVS/SCCS."
  86   :group 'pcl-cvs
  87   :prefix "log-view-")
  88
  89 (easy-mmode-defmap log-view-mode-map
  90   '(("q" . quit-window)
  91     ("z" . kill-this-buffer)
  92     ("m" . log-view-toggle-mark-entry)
  93     ;; ("e" . cvs-mode-edit-log)
  94     ("d" . log-view-diff)
  95     ("f" . log-view-find-version)
  96     ("n" . log-view-msg-next)
  97     ("p" . log-view-msg-prev)
  98     ("N" . log-view-file-next)
  99     ("P" . log-view-file-prev)
 100     ("\M-n" . log-view-file-next)
 101     ("\M-p" . log-view-file-prev))
 102   "Log-View's keymap."
 103   :group 'log-view
 104   ;; Here I really need either buffer-local keymap-inheritance
 105   ;; or a minor-mode-map with lower precedence than the local map.
 106   :inherit (if (boundp 'cvs-mode-map) cvs-mode-map))
 107
 108 (easy-menu-define log-view-mode-menu log-view-mode-map
 109   "Log-View Display Menu"
 110   `("Log-View"
 111     ;; XXX Do we need menu entries for these?
 112     ;; ["Quit"  quit-window]
 113     ;; ["Kill This Buffer"  kill-this-buffer]
 114     ["Mark Log Entry for Diff"  set-mark-command]
 115     ["Diff Revisions"  log-view-diff]
 116     ["Visit Version"  log-view-find-version]
 117     ["Next Log Entry"  log-view-msg-next]
 118     ["Previous Log Entry"  log-view-msg-prev]
 119     ["Next File"  log-view-file-next]
 120     ["Previous File"  log-view-file-prev]))
 121
 122 (defvar log-view-mode-hook nil
 123   "Hook run at the end of `log-view-mode'.")
 124
 125 (defface log-view-file
 126   '((((class color) (background light))
 127      (:background "grey70" :weight bold))
 128     (t (:weight bold)))
 129   "Face for the file header line in `log-view-mode'."
 130   :group 'log-view)
 131 ;; backward-compatibility alias
 132 (put 'log-view-file-face 'face-alias 'log-view-file)
 133 (defvar log-view-file-face 'log-view-file)
 134
 135 (defface log-view-message
 136   '((((class color) (background light))
 137      (:background "grey85"))
 138     (t (:weight bold)))
 139   "Face for the message header line in `log-view-mode'."
 140   :group 'log-view)
 141 ;; backward-compatibility alias
 142 (put 'log-view-message-face 'face-alias 'log-view-message)
 143 (defvar log-view-message-face 'log-view-message)
 144
 145 (defvar log-view-file-re
 146   (concat "^\\(?:Working file: \\(?1:.+\\)"                ;RCS and CVS.
 147           ;; Subversion has no such thing??
 148           "\\|\\(?:SCCS/s\\.\\|Changes to \\)\\(?1:.+\\):" ;SCCS and Darcs.
 149           "\\)\n")                    ;Include the \n for font-lock reasons.
 150   "Regexp matching the text identifying the file.
 151 The match group number 1 should match the file name itself.")
 152
 153 (defvar log-view-message-re
 154   (concat "^\\(?:revision \\(?1:[.0-9]+\\)\\(?:\t.*\\)?" ; RCS and CVS.
 155           "\\|r\\(?1:[0-9]+\\) | .* | .*"                ; Subversion.
 156           "\\|D \\(?1:[.0-9]+\\) .*"                     ; SCCS.
 157           ;; Darcs doesn't have revision names.  VC-darcs uses patch names
 158           ;; instead.  Darcs patch names are hashcodes, which do not appear
 159           ;; in the log output :-(, but darcs accepts any prefix of the log
 160           ;; message as a patch name, so we match the first line of the log
 161           ;; message.
 162           ;; First loosely match the date format.
 163           (concat "\\|[^ \n].*[^0-9\n][0-9][0-9]:[0-9][0-9][^0-9\n].*[^ \n]"
 164                   ;;Email of user and finally Msg, used as revision name.
 165                   "  .*@.*\n\\(?:  \\* \\(?1:.*\\)\\)?")
 166           "\\)$")
 167   "Regexp matching the text identifying a revision.
 168 The match group number 1 should match the revision number itself.")
 169
 170 (defvar log-view-font-lock-keywords
 171   ;; We use `eval' so as to use the buffer-local value of log-view-file-re
 172   ;; and log-view-message-re, if applicable.
 173   '((eval . `(,log-view-file-re
 174               (1 (if (boundp 'cvs-filename-face) cvs-filename-face))
 175               (0 log-view-file-face append)))
 176     (eval . `(,log-view-message-re . log-view-message-face))))
 177
 178 (defconst log-view-font-lock-defaults
 179   '(log-view-font-lock-keywords t nil nil nil))
 180
 181 ;;;;
 182 ;;;; Actual code
 183 ;;;;
 184
 185 ;;;###autoload
 186 (define-derived-mode log-view-mode fundamental-mode "Log-View"
 187   "Major mode for browsing CVS log output."
 188   (setq buffer-read-only t)
 189   (set (make-local-variable 'font-lock-defaults) log-view-font-lock-defaults)
 190   (set (make-local-variable 'cvs-minor-wrap-function) 'log-view-minor-wrap))
 191
 192 ;;;;
 193 ;;;; Navigation
 194 ;;;;
 195
 196 ;; define log-view-{msg,file}-{next,prev}
 197 (easy-mmode-define-navigation log-view-msg log-view-message-re "log message")
 198 (easy-mmode-define-navigation log-view-file log-view-file-re "file")
 199
 200 (defun log-view-goto-rev (rev)
 201   (goto-char (point-min))
 202   (ignore-errors
 203     (while (not (equal rev (log-view-current-tag)))
 204       (log-view-msg-next))
 205     t))
 206
 207 ;;;;
 208 ;;;; Linkage to PCL-CVS (mostly copied from cvs-status.el)
 209 ;;;;
 210
 211 (defconst log-view-dir-re "^cvs[.ex]* [a-z]+: Logging \\(.+\\)$")
 212
 213 (defun log-view-current-file ()
 214   (save-excursion
 215     (forward-line 1)
 216     (or (re-search-backward log-view-file-re nil t)
 217         (re-search-forward log-view-file-re nil t)
 218         (error "Unable to determine the current file"))
 219     (let* ((file (match-string 1))
 220            (cvsdir (and (re-search-backward log-view-dir-re nil t)
 221                         (match-string 1)))
 222            (pcldir (and (boundp 'cvs-pcl-cvs-dirchange-re)
 223                         (re-search-backward cvs-pcl-cvs-dirchange-re nil t)
 224                         (match-string 1)))
 225            (dir ""))
 226       (let ((default-directory ""))
 227         (when pcldir (setq dir (expand-file-name pcldir dir)))
 228         (when cvsdir (setq dir (expand-file-name cvsdir dir))))
 229       (expand-file-name file dir))))
 230
 231 (defun log-view-current-tag (&optional where)
 232   (save-excursion
 233     (when where (goto-char where))
 234     (forward-line 1)
 235     (let ((pt (point)))
 236       (when (re-search-backward log-view-message-re nil t)
 237         (let ((rev (match-string-no-properties 1)))
 238           (unless (re-search-forward log-view-file-re pt t)
 239             rev))))))
 240
 241 (defun log-view-toggle-mark-entry ()
 242   "Toggle the marked state for the log entry at point.
 243 Individual log entries can be marked and unmarked. The marked
 244 entries are denoted by changing their background color.
 245 `log-view-get-marked' returns the list of tags for the marked
 246 log entries."
 247   (interactive)
 248   (save-excursion
 249     (forward-line 1)
 250     (let ((pt (point)))
 251       (when (re-search-backward log-view-message-re nil t)
 252         (let ((beg (match-beginning 0))
 253               end ov ovlist found tag)
 254           (unless (re-search-forward log-view-file-re pt t)
 255             ;; Look to see if the current entry is marked.
 256             (setq found (get-char-property (point) 'log-view-self))
 257             (if found
 258                 (delete-overlay found)
 259               ;; Create an overlay that covers this entry and change
 260               ;; it's color.
 261               (setq tag (log-view-current-tag (point)))
 262               (forward-line 1)
 263               (setq end
 264                     (if (re-search-forward log-view-message-re nil t)
 265                         (match-beginning 0)
 266                       (point-max)))
 267               (setq ov (make-overlay beg end))
 268               (overlay-put ov 'face 'log-view-file)
 269               ;; This is used to check if the overlay is present.
 270               (overlay-put ov 'log-view-self ov)
 271               (overlay-put ov 'log-view-marked tag))))))))
 272
 273 (defun log-view-get-marked ()
 274   "Return the list of tags for the marked log entries."
 275   (save-excursion
 276     (let ((pos (point-min))
 277           marked-list ov)
 278       (while (setq pos (next-single-property-change pos 'face))
 279         (when (setq ov (get-char-property pos 'log-view-self))
 280           (push (overlay-get ov 'log-view-marked) marked-list)
 281           (setq pos (overlay-end ov))))
 282       marked-list)))
 283
 284 (defvar cvs-minor-current-files)
 285 (defvar cvs-branch-prefix)
 286 (defvar cvs-secondary-branch-prefix)
 287
 288 (defun log-view-minor-wrap (buf f)
 289   (let ((data (with-current-buffer buf
 290                 (let* ((beg (point))
 291                        (end (if mark-active (mark) (point)))
 292                        (fr (log-view-current-tag beg))
 293                        (to (log-view-current-tag end)))
 294                   (when (string-equal fr to)
 295                     (save-excursion
 296                       (goto-char end)
 297                       (log-view-msg-next)
 298                       (setq to (log-view-current-tag))))
 299                   (cons
 300                    ;; The first revision has to be the one at point, for
 301                    ;; operations that only take one revision
 302                    ;; (e.g. cvs-mode-edit).
 303                    (cons (log-view-current-file) fr)
 304                    (cons (log-view-current-file) to))))))
 305     (let ((cvs-branch-prefix (cdar data))
 306           (cvs-secondary-branch-prefix (and (cdar data) (cddr data)))
 307           (cvs-minor-current-files
 308            (cons (caar data)
 309                  (when (and (cadr data) (not (equal (caar data) (cadr data))))
 310                    (list (cadr data)))))
 311           ;; FIXME:  I need to force because the fileinfos are UNKNOWN
 312           (cvs-force-command "/F"))
 313       (funcall f))))
 314
 315 (defun log-view-find-version (pos)
 316   "Visit the version at point."
 317   (interactive "d")
 318   (save-excursion
 319     (goto-char pos)
 320     (switch-to-buffer (vc-find-version (log-view-current-file)
 321                                        (log-view-current-tag)))))
 322
 323 ;;
 324 ;; diff
 325 ;;
 326
 327 (defun log-view-diff (beg end)
 328   "Get the diff between two revisions.
 329 If the mark is not active or the mark is on the revision at point,
 330 get the diff between the revision at point and its previous revision.
 331 Otherwise, get the diff between the revisions where the region starts
 332 and ends."
 333   (interactive
 334    (list (if mark-active (region-beginning) (point))
 335          (if mark-active (region-end) (point))))
 336   (let ((fr (log-view-current-tag beg))
 337         (to (log-view-current-tag end)))
 338     (when (string-equal fr to)
 339       (save-excursion
 340         (goto-char end)
 341         (log-view-msg-next)
 342         (setq to (log-view-current-tag))))
 343     (vc-version-diff (log-view-current-file) to fr)))
 344
 345 (provide 'log-view)
 346
 347 ;; arch-tag: 0d64220b-ce7e-4f62-9c2a-6b04c2f81f4f
 348 ;;; log-view.el ends here