planner-log-edit.el

   1 ;;; planner-log-edit.el --- Record VC commits as a note in todays planner file
   2
   3 ;; Copyright (C) 2004, 2008 Simon Winwood (sjw AT cse.unsw.edu.au)
   4 ;; Parts copyright (C) 2004, 2008 Free Software Foundation, Inc.
   5 ;; Parts copyright (C) 2004, 2008 Dryice Dong Liu (dryice AT liu.com.cn)
   6 ;; Parts copyright (C) 2005, 2008 Yann Hodique (yann.hodique AT gmail.com)
   7
   8 ;; Author: Simon Winwood <sjw@cse.unsw.edu.au>
   9 ;; Version: 0.1
  10 ;; Keywords: planner, vc, pcl-cvs, log-edit
  11
  12 ;; This file is part of Planner.  It is not part of GNU Emacs.
  13
  14 ;; Planner is free software; you can redistribute it and/or modify it
  15 ;; under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation; either version 3, or (at your option)
  17 ;; any later version.
  18
  19 ;; Planner is distributed in the hope that it will be useful, but
  20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22 ;; General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with Planner; see the file COPYING.  If not, write to the
  26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  27 ;; Boston, MA 02110-1301, USA.
  28
  29 ;;; Commentary:
  30
  31 ;; This file records cvs (and VC) commits into todays planner file.
  32
  33 ;;; Contributors:
  34
  35 ;; Dryice Dong Liu (dryice AT liu.com.cn) provided the
  36 ;; `planner-log-edit-quote-filenames-flag' option and patched the code
  37 ;; to use it.
  38
  39 ;; Yann Hodique added the possibility to ignore patterns before
  40 ;; inserting commit messages as notes (useful for psvn) via the new
  41 ;; `planner-log-edit-flush-regexp-list' option.
  42
  43 ;;; Code:
  44
  45 (require 'planner)
  46 (require 'log-edit)
  47
  48 (defgroup planner-log-edit nil
  49   "Planner options for log-edit."
  50   :prefix "planner-log-edit-"
  51   :group 'planner)
  52
  53 (defcustom planner-log-edit-include-files-flag
  54   t
  55   "Non-nil means include a list of committed files in the note."
  56   :type 'boolean
  57   :group 'planner-log-edit)
  58
  59 (defcustom planner-log-edit-quote-filenames-flag
  60   nil
  61   "Non-nil means quote the file names with \"=\"."
  62   :type 'boolean
  63   :group 'planner-log-edit)
  64
  65 (defcustom planner-log-edit-notice-commit-function t
  66   "Function that should return non-nil if this commit should be noted.
  67 The function will be run in the log buffer."
  68   :type '(choice
  69           (const :tag "Always note commits" t)
  70           function)
  71   :group 'planner-log-edit)
  72
  73 (defcustom planner-log-edit-flush-regexp-list
  74   nil
  75   "List of regexps to flush before inserting note"
  76   :type '(repeat regexp)
  77   :group 'planner-log-edit)
  78
  79 (defcustom planner-log-edit-module-name-function 'planner-log-edit-cvs-module
  80   "Function that should return a name for the current module."
  81   :type 'function
  82   :group 'planner-log-edit)
  83
  84 (defun planner-log-edit-quote-file-maybe (arg)
  85   "Quote ARG if `planner-log-edit-quote-filenames-flag is non-nil."
  86   (if planner-log-edit-quote-filenames-flag
  87       (concat "=" arg "=")
  88     arg))
  89
  90 (defun planner-log-edit-cvs-module ()
  91   (condition-case nil
  92       (when (fboundp 'cvs-get-module) (cvs-get-module))))
  93
  94 ;;;###autoload
  95 (defun planner-log-edit-add-note ()
  96   "Add a note describing the commit to the current planner page."
  97   (let* ((buffer (current-buffer))
  98          (files (log-edit-files))
  99          ;; This should be a function call into log-edit, but until it
 100          ;; exists ...
 101          (module-name (funcall planner-log-edit-module-name-function)))
 102     (if (if (functionp planner-log-edit-notice-commit-function)
 103             (funcall planner-log-edit-notice-commit-function)
 104           planner-log-edit-notice-commit-function)
 105         (save-excursion
 106           (save-window-excursion
 107             (planner-create-note nil)
 108             (insert "Commit"
 109                     (if module-name
 110                         (concat " in "
 111                                 (planner-log-edit-quote-file-maybe
 112                                  module-name))
 113                       ""))
 114             (newline)
 115             (when planner-log-edit-include-files-flag
 116               (insert "Files: ")
 117               (insert (mapconcat 'planner-log-edit-quote-file-maybe files " "))
 118               (newline)
 119               (newline))
 120             (insert
 121              (with-temp-buffer
 122                (insert-buffer-substring buffer)
 123                (goto-char (point-min))
 124                (mapc (lambda (regexp)
 125                        (flush-lines regexp))
 126                      planner-log-edit-flush-regexp-list)
 127                (buffer-string)))
 128             ;(insert-buffer-substring buffer)
 129             )))))
 130
 131 (add-hook 'log-edit-done-hook 'planner-log-edit-add-note)
 132
 133 (provide 'planner-log-edit)
 134
 135 ;;; planner-log-edit.el ends here