1 ;;; gnus-eform.el --- a mode for editing forms for Gnus
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; This file is part of GNU Emacs.
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)
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.
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.
37 (defgroup gnus-edit-form nil
38 "A mode for editing forms."
41 (defcustom gnus-edit-form-mode-hook nil
42 "Hook run in `gnus-edit-form-mode' buffers."
43 :group
'gnus-edit-form
46 (defcustom gnus-edit-form-menu-hook nil
47 "Hook run when creating menus in `gnus-edit-form-mode' buffers."
48 :group
'gnus-edit-form
51 ;;; Internal variables
53 (defvar gnus-edit-form-buffer
"*Gnus edit form*")
54 (defvar gnus-edit-form-done-function nil
)
56 (defvar gnus-edit-form-mode-map nil
)
57 (unless gnus-edit-form-mode-map
58 (setq gnus-edit-form-mode-map
(make-sparse-keymap))
59 (set-keymap-parent gnus-edit-form-mode-map emacs-lisp-mode-map
)
60 (gnus-define-keys gnus-edit-form-mode-map
61 "\C-c\C-c" gnus-edit-form-done
62 "\C-c\C-k" gnus-edit-form-exit
))
64 (defun gnus-edit-form-make-menu-bar ()
65 (unless (boundp 'gnus-edit-form-menu
)
67 gnus-edit-form-menu gnus-edit-form-mode-map
""
69 ["Exit and save changes" gnus-edit-form-done t
]
70 ["Exit" gnus-edit-form-exit t
]))
71 (gnus-run-hooks 'gnus-edit-form-menu-hook
)))
73 (defun gnus-edit-form-mode ()
74 "Major mode for editing forms.
75 It is a slightly enhanced emacs-lisp-mode.
77 \\{gnus-edit-form-mode-map}"
79 (when (gnus-visual-p 'group-menu
'menu
)
80 (gnus-edit-form-make-menu-bar))
81 (kill-all-local-variables)
82 (setq major-mode
'gnus-edit-form-mode
)
83 (setq mode-name
"Edit Form")
84 (use-local-map gnus-edit-form-mode-map
)
85 (make-local-variable 'gnus-edit-form-done-function
)
86 (make-local-variable 'gnus-prev-winconf
)
87 (gnus-run-mode-hooks 'gnus-edit-form-mode-hook
))
89 (defun gnus-edit-form (form documentation exit-func
&optional layout
)
90 "Edit FORM in a new buffer.
91 Call EXIT-FUNC on exit. Display DOCUMENTATION in the beginning
93 The optional LAYOUT overrides the `edit-form' window layout."
94 (let ((winconf (current-window-configuration)))
95 (set-buffer (gnus-get-buffer-create gnus-edit-form-buffer
))
96 (gnus-configure-windows (or layout
'edit-form
))
98 (setq gnus-prev-winconf winconf
)
99 (setq gnus-edit-form-done-function exit-func
)
101 (insert documentation
)
104 (goto-char (point-min))
108 (insert ";; Type `C-c C-c' after you've finished editing.\n")
115 (defun gnus-edit-form-done ()
116 "Update changes and kill the current buffer."
118 (goto-char (point-min))
119 (let ((form (condition-case nil
120 (read (current-buffer))
122 (func gnus-edit-form-done-function
))
123 (gnus-edit-form-exit)
124 (funcall func form
)))
126 (defun gnus-edit-form-exit ()
127 "Kill the current buffer."
129 (let ((winconf gnus-prev-winconf
))
130 (kill-buffer (current-buffer))
131 (set-window-configuration winconf
)))
133 (provide 'gnus-eform
)
135 ;;; arch-tag: ef50678c-2c28-49ef-affc-e53b3b2c0bf6
136 ;;; gnus-eform.el ends here