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