|
502
|
1 ;;; behavior.el --- consistent interface onto behaviors
|
|
|
2
|
|
800
|
3 ;; Copyright (C) 2000, 2001, 2002 Ben Wing.
|
|
502
|
4
|
|
|
5 ;; Author: Ben Wing
|
|
|
6 ;; Maintainer: XEmacs Development Team
|
|
|
7 ;; Keywords: internal, dumped
|
|
|
8
|
|
|
9 ;; This file is part of XEmacs.
|
|
|
10
|
|
|
11 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
12 ;; under the terms of the GNU General Public License as published by
|
|
|
13 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
14 ;; any later version.
|
|
|
15
|
|
|
16 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
19 ;; General Public License for more details.
|
|
|
20
|
|
|
21 ;; You should have received a copy of the GNU General Public License
|
|
|
22 ;; along with XEmacs; see the file COPYING. If not, write to the
|
|
|
23 ;; Free Software Foundation, 59 Temple Place - Suite 330,
|
|
|
24 ;; Boston, MA 02111-1307, USA.
|
|
|
25
|
|
|
26 ;;; Synched up with: Not in FSF.
|
|
|
27
|
|
|
28 ;;; Authorship:
|
|
|
29
|
|
|
30 ;; Created July 2000 by Ben Wing.
|
|
|
31
|
|
|
32 ;;; Commentary:
|
|
|
33
|
|
|
34 ;; This file will be dumped with XEmacs.
|
|
|
35
|
|
|
36 ;;; Code:
|
|
|
37
|
|
800
|
38 ;; Hash table mapping behavior names to property lists, with entries for
|
|
|
39 ;; :short-doc, :require, :enable, and :disable.
|
|
|
40 (defconst behavior-hash-table (make-hash-table))
|
|
|
41
|
|
|
42 (defvar within-behavior-enabling-disabling nil)
|
|
|
43
|
|
|
44 (defgroup behaviors nil
|
|
|
45 "Behaviors -- high-level functionality interface.")
|
|
|
46
|
|
|
47 ;; List of enabled behaviors.
|
|
|
48 (defcustom enabled-behavior-list nil
|
|
|
49 "List of currently enabled behaviors.
|
|
|
50 Normally, don't set it directly; use `enable-behavior' or `disable-behavior'."
|
|
|
51 :initialize #'set-default
|
|
|
52 :set #'(lambda (sym val)
|
|
|
53 (if within-behavior-enabling-disabling
|
|
|
54 (set sym val)
|
|
|
55 (let* ((old-val enabled-behavior-list)
|
|
|
56 (disable-list (set-difference old-val val))
|
|
|
57 (enable-list (set-difference val old-val)))
|
|
|
58 (dolist (b disable-list)
|
|
|
59 (disable-behavior b t))
|
|
|
60 (dolist (b enable-list)
|
|
|
61 (enable-behavior b t))
|
|
|
62 (assert (equal enabled-behavior-list val)))))
|
|
|
63 :type '(repeat (symbol :tag "Behavior"))
|
|
|
64 :group 'behaviors)
|
|
|
65
|
|
502
|
66
|
|
|
67 (defvar behavior-history nil
|
|
|
68 "History of entered behaviors.")
|
|
|
69
|
|
|
70 (defun define-behavior (name doc-string &rest cl-keys)
|
|
|
71 "Define a behavior named NAME.
|
|
|
72 DOC-STRING must be specified, a description of what the behavior does
|
|
|
73 when it's enabled and how to further control it (typically through
|
|
|
74 custom variables). Accepted keywords are
|
|
|
75
|
|
800
|
76 :short-doc A \"pretty\" version of the name, for use in menus. If omitted
|
|
|
77 a prettified name will be generated.
|
|
|
78 :require A single symbol or a list of such symbols, which need to be
|
|
|
79 present at enable time, or will be loaded using `require'.
|
|
|
80 :enable A function of no variables, which turns the behavior on.
|
|
|
81 :disable A function of no variables, which turns the behavior off.
|
|
502
|
82
|
|
|
83 Behaviors are assumed to be global, and to take effect immediately; if
|
|
|
84 the underlying package is per-buffer, it may have to scan all existing
|
|
|
85 buffers and frob them. When a behavior is disabled, it should completely
|
|
|
86 go away *everywhere*, as if it were never invoked at all.
|
|
|
87
|
|
|
88 The :disable keywords can be missing, although this is considered bad
|
|
|
89 practice. In such a case, attempting to disable the behavior will signal
|
|
|
90 an error unless you use the `force' option."
|
|
|
91 (cl-parsing-keywords
|
|
800
|
92 ((:short-doc (capitalize-string-as-title (replace-in-string
|
|
|
93 (symbol-name name) "-" " ")))
|
|
502
|
94 :require
|
|
|
95 :enable
|
|
|
96 :disable)
|
|
|
97 ()
|
|
800
|
98 (let ((entry (list :short-doc cl-short-doc :require cl-require
|
|
502
|
99 :enable cl-enable :disable cl-disable)))
|
|
|
100 (puthash name entry behavior-hash-table))))
|
|
|
101
|
|
|
102 (defun read-behavior (prompt &optional must-match initial-contents history
|
|
|
103 default-value)
|
|
|
104 "Return a behavior symbol from the minibuffer, prompting with string PROMPT.
|
|
|
105 If non-nil, optional second arg INITIAL-CONTENTS is a string to insert
|
|
|
106 in the minibuffer before reading.
|
|
|
107 Third arg HISTORY, if non-nil, specifies a history list. (It defaults to
|
|
|
108 `behavior-history'.)
|
|
|
109 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used
|
|
|
110 for history command, and as the value to return if the user enters the
|
|
|
111 empty string."
|
|
|
112 (let ((result
|
|
|
113 (completing-read
|
|
|
114 prompt
|
|
|
115 (let ((table (let (lis)
|
|
|
116 (maphash #'(lambda (key val)
|
|
|
117 (push (cons key val) lis))
|
|
|
118 behavior-hash-table)
|
|
|
119 (nreverse lis))))
|
|
|
120 (mapc #'(lambda (aentry)
|
|
|
121 (setcar aentry (symbol-name
|
|
|
122 (car aentry))))
|
|
|
123 table)
|
|
|
124 table)
|
|
|
125 nil must-match initial-contents
|
|
|
126 (or history 'behavior-history)
|
|
|
127 default-value)))
|
|
|
128 (if (and result (stringp result))
|
|
|
129 (intern result)
|
|
|
130 result)))
|
|
|
131
|
|
800
|
132 (defun behavior-enabled-p (behavior)
|
|
|
133 "Non-nil if BEHAVIOR (a symbol) if currently enabled."
|
|
|
134 (memq behavior enabled-behavior-list))
|
|
502
|
135
|
|
|
136 (defun enable-behavior (behavior &optional force)
|
|
|
137 "Enable the specified behavior."
|
|
|
138 (interactive (list (read-behavior "Enable Behavior: " t) current-prefix-arg))
|
|
|
139 (let ((plist (gethash behavior behavior-hash-table)))
|
|
|
140 (or plist (error 'invalid-argument "Not a behavior" behavior))
|
|
800
|
141 (or force (not (memq behavior enabled-behavior-list))
|
|
|
142 (error 'invalid-change "Behavior already enabled" behavior))
|
|
502
|
143 (let ((require (getf plist :require))
|
|
|
144 (enable (getf plist :enable)))
|
|
|
145 (cond ((listp require)
|
|
|
146 (mapc #'(lambda (sym) (require sym)) require))
|
|
|
147 ((symbolp require)
|
|
|
148 (require require))
|
|
|
149 ((null require))
|
|
|
150 (t (error 'invalid-argument "Invalid :require spec" require)))
|
|
800
|
151 (message "Enabling behavior %s..." behavior)
|
|
|
152 (if enable (funcall enable))
|
|
|
153 (message "Enabling behavior %s...done" behavior)
|
|
|
154 (let ((within-behavior-enabling-disabling t))
|
|
|
155 (customize-set-variable 'enabled-behavior-list
|
|
|
156 (cons behavior enabled-behavior-list))))))
|
|
502
|
157
|
|
|
158 (defun disable-behavior (behavior &optional force)
|
|
|
159 "Disable the specified behavior."
|
|
|
160 (interactive (list (read-behavior "Disable Behavior: " t)
|
|
|
161 current-prefix-arg))
|
|
|
162 (let ((plist (gethash behavior behavior-hash-table)))
|
|
|
163 (or plist (error 'invalid-argument "Not a behavior" behavior))
|
|
800
|
164 (or force (memq behavior enabled-behavior-list)
|
|
|
165 (error 'invalid-change "Behavior not enabled" behavior))
|
|
502
|
166 (let ((require (getf plist :require))
|
|
|
167 (disable (getf plist :disable)))
|
|
|
168 (cond ((listp require)
|
|
|
169 (mapc #'(lambda (sym) (require sym)) require))
|
|
|
170 ((symbolp require)
|
|
|
171 (require require))
|
|
|
172 ((null require))
|
|
|
173 (t (error 'invalid-argument "Invalid :require spec" require)))
|
|
800
|
174 (message "Disabling behavior %s..." behavior)
|
|
|
175 (if disable (funcall disable))
|
|
|
176 (message "Disabling behavior %s...done" behavior)
|
|
|
177 (let ((within-behavior-enabling-disabling t))
|
|
|
178 (customize-set-variable 'enabled-behavior-list
|
|
|
179 (delq behavior enabled-behavior-list))))))
|
|
502
|
180
|
|
|
181 (provide 'behavior)
|
|
|
182
|
|
|
183 ;;; finder-inf.el ends here
|
