1 ;;; gmm-utils.el --- Utility functions for Gnus, Message and MML
3 ;; Copyright (C) 2006 Free Software Foundation, Inc.
5 ;; Author: Reiner Steib <reiner.steib@gmx.de>
8 ;; This file is part of GNU Emacs.
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)
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.
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., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 ;; This library provides self-contained utility functions. The functions are
28 ;; used in Gnus, Message and MML, but within this library there are no
29 ;; dependencies on Gnus, Message, or MML or Gnus.
34 "Utility functions for Gnus, Message and MML"
36 :version "23.0" ;; No Gnus
39 ;; Helper functions from `gnus-utils.el': gmm-verbose, gmm-message, gmm-error
41 (defcustom gmm-verbose 7
42 "Integer that says how verbose gmm should be.
43 The higher the number, the more messages will flash to say what
44 it done. At zero, it will be totally mute; at five, it will
45 display most important messages; and at ten, it will keep on
46 jabbering all the time."
51 (defun gmm-message (level &rest args)
52 "If LEVEL is lower than `gmm-verbose' print ARGS using `message'.
54 Guideline for numbers:
55 1 - error messages, 3 - non-serious error messages, 5 - messages for things
56 that take a long time, 7 - not very important messages on stuff, 9 - messages
58 (if (<= level gmm-verbose)
60 ;; We have to do this format thingy here even if the result isn't
61 ;; shown - the return value has to be the same as the return value
63 (apply 'format args)))
66 (defun gmm-error (level &rest args)
67 "Beep an error if LEVEL is equal to or less than `gmm-verbose'.
68 ARGS are passed to `message'."
69 (when (<= (floor level) gmm-verbose)
73 (when (and (floatp level)
74 (not (zerop (setq duration (* 10 (- level (floor level)))))))
79 (defun gmm-widget-p (symbol)
80 "Non-nil iff SYMBOL is a widget."
81 (get symbol 'widget-type))
83 ;; Copy of the `nnmail-lazy' code from `nnmail.el':
84 (define-widget 'gmm-lazy 'default
85 "Base widget for recursive datastructures.
87 This is copy of the `lazy' widget in Emacs 22.1 provided for compatibility."
89 :convert-widget 'widget-value-convert-widget
90 :value-create (lambda (widget)
91 (let ((value (widget-get widget :value))
92 (type (widget-get widget :type)))
93 (widget-put widget :children
94 (list (widget-create-child-value
95 widget (widget-convert type) value)))))
96 :value-delete 'widget-children-value-delete
97 :value-get (lambda (widget)
98 (widget-value (car (widget-get widget :children))))
99 :value-inline (lambda (widget)
100 (widget-apply (car (widget-get widget :children))
102 :default-get (lambda (widget)
104 (widget-convert (widget-get widget :type))))
105 :match (lambda (widget value)
106 (widget-apply (widget-convert (widget-get widget :type))
108 :validate (lambda (widget)
109 (widget-apply (car (widget-get widget :children)) :validate)))
111 ;; Note: The format of `gmm-tool-bar-item' may change if some future Emacs
112 ;; version will provide customizable tool bar buttons using a different
115 (define-widget 'gmm-tool-bar-item (if (gmm-widget-p 'lazy) 'lazy 'gmm-lazy)
116 "Tool bar list item."
119 (list :tag "Command and Icon"
120 (function :tag "Command")
121 (string :tag "Icon file")
123 (const :tag "Default map" nil)
124 ;; Note: Usually we need non-nil attributes if map is t.
125 (const :tag "No menu" t)
126 (sexp :tag "Other map"))
127 (plist :inline t :tag "Properties"))
128 (list :tag "Separator"
129 (const :tag "No command" gmm-ignore)
130 (string :tag "Icon file")
131 (const :tag "No map")
132 (plist :inline t :tag "Properties"))))
134 (define-widget 'gmm-tool-bar-zap-list (if (gmm-widget-p 'lazy) 'lazy 'gmm-lazy)
136 :tag "Tool bar zap list"
137 :type '(choice (const :tag "Zap all" t)
138 (const :tag "Keep all" nil)
141 ;; Work around (bug in customize?), see
142 ;; <news:v9is48jrj1.fsf@marauder.physik.uni-ulm.de>
143 ;; (new-file open-file dired kill-buffer write-file
144 ;; print-buffer customize help)
156 (const search-forward)
162 (symbol :tag "Icon item")))))
164 (defvar tool-bar-map)
167 (defun gmm-tool-bar-from-list (icon-list zap-list default-map)
168 "Make a tool bar from ICON-LIST.
170 Within each entry of ICON-LIST, the first element is a menu
171 command, the second element is an icon file name and the third
172 element is a test function. You can use \\[describe-key]
173 <menu-entry> to find out the name of a menu command. The fourth
174 and all following elements are passed a the PROPS argument to the
175 function `tool-bar-local-item'.
177 If ZAP-LIST is a list, remove those item from the default
178 `tool-bar-map'. If it is t, start with a new sparse map. You
179 can use \\[describe-key] <icon> to find out the name of an icon
180 item. When \\[describe-key] <icon> shows \"<tool-bar> <new-file>
181 runs the command find-file\", then use `new-file' in ZAP-LIST.
183 DEFAULT-MAP specifies the default key map for ICON-LIST."
184 (let (;; For Emacs 21, we must let-bind `tool-bar-map'. In Emacs 22, we
185 ;; could use some other local variable.
186 (tool-bar-map (if (eq zap-list t)
188 (copy-keymap tool-bar-map))))
189 (when (listp zap-list)
190 ;; Zap some items which aren't relevant for this mode and take up space.
191 (dolist (key zap-list)
192 (define-key tool-bar-map (vector key) nil)))
194 (let ((command (car el))
196 (fmap (or (nth 2 el) default-map))
197 (props (cdr (cdr (cdr el)))) )
198 ;; command may stem from different from-maps:
199 (cond ((eq command 'gmm-ignore)
200 ;; The dummy `gmm-ignore', see `gmm-tool-bar-item'
201 ;; widget. Suppress tooltip by adding `:enable nil'.
202 (if (fboundp 'tool-bar-local-item)
203 (apply 'tool-bar-local-item icon nil nil
204 tool-bar-map :enable nil props)
205 ;; (tool-bar-local-item ICON DEF KEY MAP &rest PROPS)
206 ;; (tool-bar-add-item ICON DEF KEY &rest PROPS)
207 (apply 'tool-bar-add-item icon nil nil :enable nil props)))
208 ((equal fmap t) ;; Not a menu command
209 (if (fboundp 'tool-bar-local-item)
210 (apply 'tool-bar-local-item
212 (intern icon) ;; reuse icon or fmap here?
214 ;; Emacs 21 compatibility:
215 (apply 'tool-bar-add-item
220 (if (fboundp 'tool-bar-local-item-from-menu)
221 (apply 'tool-bar-local-item-from-menu
222 ;; (apply 'tool-bar-local-item icon def key
223 ;; tool-bar-map props)
224 command icon tool-bar-map (symbol-value fmap)
226 ;; Emacs 21 compatibility:
227 (apply 'tool-bar-add-item-from-menu
228 command icon (symbol-value fmap)
231 (if (symbolp icon-list)
238 ;;; gmm-utils.el ends here