* gnus-util.el (gnus-run-mode-hooks): New function.
[gnus] / lisp / score-mode.el
1 ;;; score-mode.el --- mode for editing Gnus score files
2
3 ;; Copyright (C) 1996, 2001, 2004, 2005 Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, mail
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval-when-compile (require 'cl))
30 (require 'mm-util)                      ; for mm-universal-coding-system
31 (require 'gnus-util)                    ; for gnus-pp, gnus-run-mode-hooks
32
33 (defvar gnus-score-mode-hook nil
34   "*Hook run in score mode buffers.")
35
36 (defvar gnus-score-menu-hook nil
37   "*Hook run after creating the score mode menu.")
38
39 (defvar gnus-score-edit-exit-function nil
40   "Function run on exit from the score buffer.")
41
42 (defvar gnus-score-mode-map nil)
43 (unless gnus-score-mode-map
44   (setq gnus-score-mode-map (make-sparse-keymap))
45   (set-keymap-parent gnus-score-mode-map emacs-lisp-mode-map)
46   (define-key gnus-score-mode-map "\C-c\C-c" 'gnus-score-edit-exit)
47   (define-key gnus-score-mode-map "\C-c\C-d" 'gnus-score-edit-insert-date)
48   (define-key gnus-score-mode-map "\C-c\C-p" 'gnus-score-pretty-print))
49
50 (defvar score-mode-syntax-table
51   (let ((table (copy-syntax-table lisp-mode-syntax-table)))
52     (modify-syntax-entry ?| "w" table)
53     table)
54   "Syntax table used in score-mode buffers.")
55
56 ;; We need this to cope with non-ASCII scoring.
57 (defvar score-mode-coding-system mm-universal-coding-system)
58
59 ;;;###autoload
60 (defun gnus-score-mode ()
61   "Mode for editing Gnus score files.
62 This mode is an extended emacs-lisp mode.
63
64 \\{gnus-score-mode-map}"
65   (interactive)
66   (kill-all-local-variables)
67   (use-local-map gnus-score-mode-map)
68   (gnus-score-make-menu-bar)
69   (set-syntax-table score-mode-syntax-table)
70   (setq major-mode 'gnus-score-mode)
71   (setq mode-name "Score")
72   (lisp-mode-variables nil)
73   (make-local-variable 'gnus-score-edit-exit-function)
74   (gnus-run-mode-hooks 'emacs-lisp-mode-hook 'gnus-score-mode-hook))
75
76 (defun gnus-score-make-menu-bar ()
77   (unless (boundp 'gnus-score-menu)
78     (easy-menu-define
79      gnus-score-menu gnus-score-mode-map ""
80      '("Score"
81        ["Exit" gnus-score-edit-exit t]
82        ["Insert date" gnus-score-edit-insert-date t]
83        ["Format" gnus-score-pretty-print t]))
84     (run-hooks 'gnus-score-menu-hook)))
85
86 (defun gnus-score-edit-insert-date ()
87   "Insert date in numerical format."
88   (interactive)
89   (princ (time-to-days (current-time)) (current-buffer)))
90
91 (defun gnus-score-pretty-print ()
92   "Format the current score file."
93   (interactive)
94   (goto-char (point-min))
95   (let ((form (read (current-buffer))))
96     (erase-buffer)
97     (let ((emacs-lisp-mode-syntax-table score-mode-syntax-table))
98       (gnus-pp form)))
99   (goto-char (point-min)))
100
101 (defun gnus-score-edit-exit ()
102   "Stop editing the score file."
103   (interactive)
104   (unless (file-exists-p (file-name-directory (buffer-file-name)))
105     (make-directory (file-name-directory (buffer-file-name)) t))
106   (let ((coding-system-for-write score-mode-coding-system))
107     (save-buffer))
108   (bury-buffer (current-buffer))
109   (let ((buf (current-buffer)))
110     (when gnus-score-edit-exit-function
111       (funcall gnus-score-edit-exit-function))
112     (when (eq buf (current-buffer))
113       (switch-to-buffer (other-buffer (current-buffer))))))
114
115 (provide 'score-mode)
116
117 ;;; arch-tag: a74a416b-2505-4ad4-bc4e-a418c96b8845
118 ;;; score-mode.el ends here