lisp/gnus/score-mode.el

   1 ;;; score-mode.el --- mode for editing Gnus score files
   2
   3 ;; Copyright (C) 1996, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news, mail
   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 of the License, or
  14 ;; (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (eval-when-compile (require 'cl))
  29 (require 'mm-util)                      ; for mm-universal-coding-system
  30 (require 'gnus-util)                    ; for gnus-pp, gnus-run-mode-hooks
  31
  32 (defvar gnus-score-edit-done-hook nil
  33   "*Hook run at the end of closing the score buffer.")
  34
  35 (defvar gnus-score-mode-hook nil
  36   "*Hook run in score mode buffers.")
  37
  38 (defvar gnus-score-menu-hook nil
  39   "*Hook run after creating the score mode menu.")
  40
  41 (defvar gnus-score-edit-exit-function nil
  42   "Function run on exit from the score buffer.")
  43
  44 (defvar gnus-score-mode-map nil)
  45 (unless gnus-score-mode-map
  46   (setq gnus-score-mode-map (make-sparse-keymap))
  47   (set-keymap-parent gnus-score-mode-map emacs-lisp-mode-map)
  48   (define-key gnus-score-mode-map "\C-c\C-c" 'gnus-score-edit-exit)
  49   (define-key gnus-score-mode-map "\C-c\C-d" 'gnus-score-edit-insert-date)
  50   (define-key gnus-score-mode-map "\C-c\C-p" 'gnus-score-pretty-print))
  51
  52 (defvar score-mode-syntax-table
  53   (let ((table (copy-syntax-table lisp-mode-syntax-table)))
  54     (modify-syntax-entry ?| "w" table)
  55     table)
  56   "Syntax table used in score-mode buffers.")
  57
  58 ;; We need this to cope with non-ASCII scoring.
  59 (defvar score-mode-coding-system mm-universal-coding-system)
  60
  61 ;;;###autoload
  62 (defun gnus-score-mode ()
  63   "Mode for editing Gnus score files.
  64 This mode is an extended emacs-lisp mode.
  65
  66 \\{gnus-score-mode-map}"
  67   (interactive)
  68   (kill-all-local-variables)
  69   (use-local-map gnus-score-mode-map)
  70   (gnus-score-make-menu-bar)
  71   (set-syntax-table score-mode-syntax-table)
  72   (setq major-mode 'gnus-score-mode)
  73   (setq mode-name "Score")
  74   (lisp-mode-variables nil)
  75   (make-local-variable 'gnus-score-edit-exit-function)
  76   (gnus-run-mode-hooks 'emacs-lisp-mode-hook 'gnus-score-mode-hook))
  77
  78 (defun gnus-score-make-menu-bar ()
  79   (unless (boundp 'gnus-score-menu)
  80     (easy-menu-define
  81      gnus-score-menu gnus-score-mode-map ""
  82      '("Score"
  83        ["Exit" gnus-score-edit-exit t]
  84        ["Insert date" gnus-score-edit-insert-date t]
  85        ["Format" gnus-score-pretty-print t]))
  86     (run-hooks 'gnus-score-menu-hook)))
  87
  88 (defun gnus-score-edit-insert-date ()
  89   "Insert date in numerical format."
  90   (interactive)
  91   (princ (time-to-days (current-time)) (current-buffer)))
  92
  93 (defun gnus-score-pretty-print ()
  94   "Format the current score file."
  95   (interactive)
  96   (goto-char (point-min))
  97   (let ((form (read (current-buffer))))
  98     (erase-buffer)
  99     (let ((emacs-lisp-mode-syntax-table score-mode-syntax-table))
 100       (gnus-pp form)))
 101   (goto-char (point-min)))
 102
 103 (defun gnus-score-edit-exit ()
 104   "Stop editing the score file."
 105   (interactive)
 106   (unless (file-exists-p (file-name-directory (buffer-file-name)))
 107     (make-directory (file-name-directory (buffer-file-name)) t))
 108   (let ((coding-system-for-write score-mode-coding-system))
 109     (save-buffer))
 110   (bury-buffer (current-buffer))
 111   (let ((buf (current-buffer)))
 112     (when gnus-score-edit-exit-function
 113       (funcall gnus-score-edit-exit-function))
 114     (when (eq buf (current-buffer))
 115       (switch-to-buffer (other-buffer (current-buffer))))))
 116
 117 (provide 'score-mode)
 118
 119 ;;; score-mode.el ends here