* Riece: Version 0.1.7 released.
[riece] / lisp / riece-options.el
1 ;;; riece-options.el --- customization
2 ;; Copyright (C) 1998-2003 Daiki Ueno
3
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Created: 1998-09-28
6 ;; Keywords: IRC, riece
7
8 ;; This file is part of Riece.
9
10 ;; This program 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 ;; This program 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 ;;; Code:
26
27 (require 'riece-version)
28 (require 'riece-globals)
29
30 ;; User modifiable variables.
31 (defgroup riece nil
32   "Riece specific customize group")
33
34 (defgroup riece-options nil
35   "Riece user customizable variables"
36   :prefix "riece-"
37   :group 'riece)
38
39 (defcustom riece-saved-forms
40   '(riece-server-alist
41     riece-channel-buffer-mode
42     riece-user-list-buffer-mode
43     riece-layout)
44   "Variables saved after each session is completed."
45   :type 'string
46   :group 'riece-options)
47
48 (defcustom riece-debug nil
49   "If non-nil, random debug spews."
50   :type 'boolean
51   :group 'riece-options)
52
53 (defcustom riece-command-prefix "\C-c"
54   "Key sequence to be used as prefix for command mode key bindings."
55   :type 'string
56   :group 'riece-options)
57
58 (defgroup riece-looks nil
59   "Related to look and feel"
60   :prefix "riece-"
61   :group 'riece)
62
63 (defcustom riece-truncate-partial-width-windows nil
64   "If non-nil, truncate lines in splitting windows such as others buffer."
65   :type 'boolean
66   :group 'riece-looks)
67
68 (defcustom riece-use-full-window t
69   "If non-nil, whole Emacs window is used to display dialogue."
70   :type 'boolean
71   :group 'riece-looks)
72
73 (defcustom riece-directory (expand-file-name "~/.riece")
74   "Where to look for data files."
75   :type 'directory
76   :group 'riece-options)
77
78 (defcustom riece-addon-directory
79   (expand-file-name "addons" riece-directory)
80   "Where to look for add-on files."
81   :type 'directory
82   :group 'riece-options)
83   
84 (defcustom riece-variables-file
85   (expand-file-name "init" riece-directory)
86   "Where to look for variables."
87   :type 'file
88   :group 'riece-options)
89
90 (defcustom riece-saved-variables-file
91   (expand-file-name "save" riece-directory)
92   "Where to look for variables.
93 This file was saved the last session."
94   :type 'file
95   :group 'riece-options)
96
97 (defcustom riece-variables-files
98   (list riece-saved-variables-file riece-variables-file)
99   "Where to look for variables.  Helps to remove clutter from your .emacs.
100 This feature is most likely to dissappear in near future.  The preferred
101 way is to put Riece variables on .emacs or file loaded from there."
102   :type '(repeat (file :tag "Initialization File"))
103   :group 'riece-options)
104
105 (defcustom riece-addons '(riece-highlight
106                           riece-ctcp
107                           riece-guess
108                           riece-unread
109                           riece-history
110                           riece-url
111                           riece-button
112                           riece-menu
113                           riece-icon)
114   "Add-ons insinuated into Riece."
115   :type '(repeat symbol)
116   :group 'riece-options)
117
118 (defgroup riece-server nil
119   "Server settings"
120   :prefix "riece-"
121   :group 'riece)
122
123 (defgroup riece-channel nil
124   "Channel settings"
125   :prefix "riece-"
126   :group 'riece)
127
128 (define-widget 'riece-service-spec 'radio
129   "Edit service spec entries"
130   :convert-widget 'riece-service-spec-convert)
131
132 (defun riece-service-spec-convert (widget)
133   (widget-put widget :args '((integer :tag "Port Number")
134                              (string :tag "Name")))
135   widget)
136
137 (define-widget 'riece-server-spec 'repeat
138   "Edit server spec entries"
139   :match (lambda (widget value)
140            (eval `(and ,@(mapcar
141                           (lambda (entry)
142                             (or (stringp (cdr entry))
143                                 (listp (cdr entry))))
144                           value))))
145   :convert-widget 'riece-server-spec-convert)
146
147 (defun riece-server-spec-convert (widget)
148   (let* ((host '(const :format "" :value :host))
149          (service '(const :format "" :value :service))
150          (host
151           `(group :inline t ,host (string :tag "Host")))
152          (service
153           `(group :inline t ,service riece-service-spec))
154          (spec
155           `(cons (string :tag "Name")
156                  (radio (string :tag "Host")
157                         (list ,host ,service))))
158          (args (list spec)))
159     (widget-put widget :args args)
160     widget))
161   
162 (defcustom riece-server-alist nil
163   "An alist mapping server names to plist."
164   :type 'riece-server-spec
165   :group 'riece-server)
166
167 (defcustom riece-server (getenv "IRCSERVER")
168   "IRC server host we are connecting to."
169   :type 'string
170   :group 'riece-server)
171
172 (defcustom riece-default-password (getenv "IRCPASSWORD")
173   "Your password."
174   :type '(radio (string :tag "Password")
175                 (const :tag "No" nil))
176   :group 'riece-server)
177
178 (defcustom riece-username (or (getenv "IRCNAME")
179                               (user-real-login-name))
180   "Your user name."
181   :type 'string
182   :group 'riece-server)
183
184 (defcustom riece-nickname (or (getenv "IRCNICK")
185                               (user-real-login-name))
186   "Your nickname."
187   :type 'string
188   :group 'riece-server)
189
190 (defcustom riece-startup-channel-list nil
191   "A list of channels to join automatically at startup."
192   :type '(repeat (choice (string :tag "Channel")
193                          (list (string :tag "Channel") (string :tag "Key"))))
194   :group 'riece-channel)
195
196 (defcustom riece-startup-server-list nil
197   "A list of servers to connect automatically at startup."
198   :type '(repeat (string :tag "Server"))
199   :group 'riece-server)
200
201 (defcustom riece-retry-with-new-nickname nil
202   "When nickname has already been in use, grow-tail automatically."
203   :type 'boolean
204   :group 'riece-server)
205
206 (defcustom riece-quit-timeout 10
207   "Quit timeout when there is no response from server."
208   :type '(radio (integer :tag "Seconds")
209                 (const nil))
210   :group 'riece-server)
211
212 (defcustom riece-default-open-connection-function #'open-network-stream
213   "Default function used for connecting to an IRC server."
214   :type 'function
215   :group 'riece-server)
216
217 (defcustom riece-channel-buffer-mode t
218   "When non-nil, Riece will display a channel buffer."
219   :type 'boolean
220   :group 'riece-looks)
221
222 (defcustom riece-user-list-buffer-mode t
223   "When non-nil, Riece will display a nick list buffer."
224   :type 'boolean
225   :group 'riece-looks)
226
227 (defcustom riece-channel-list-buffer-mode t
228   "When non-nil, Riece will display a channel list buffer."
229   :type 'boolean
230   :group 'riece-looks)
231
232 (defcustom riece-default-freeze nil
233   "Channel buffer local freeze flag is on at starting."
234   :type 'boolean
235   :group 'riece-looks)
236
237 (defcustom riece-default-channel-binding nil
238   "The channel list to bind the channel number when joining."
239   :type '(repeat (radio (string :tag "Bound Channel")
240                         (const nil)))
241   :group 'riece-channel)
242
243 (defcustom riece-blink-parens nil
244   "Should we blink matching parenthesis in the command buffer?"
245   :type 'boolean
246   :group 'riece-options)
247
248 (defcustom riece-quit-message (riece-extended-version)
249   "Default quit message."
250   :type '(string :tag "Quit message")
251   :group 'riece-options)
252
253 (defcustom riece-away-message "Gone"
254   "Default away message."
255   :type '(string :tag "Away message")
256   :group 'riece-options)
257
258 (defcustom riece-gather-channel-modes nil
259   "If non-nil, gather channel modes when we join a channel."
260   :type 'boolean
261   :group 'riece-options)
262
263 (defcustom riece-buffer-dispose-function #'bury-buffer
264   "Function called after the buffer was disposed."
265   :type 'function
266   :group 'riece-options)
267
268 (defcustom riece-shrink-buffer-idle-time-delay 5
269   "Number of idle seconds to wait before shrinking channel buffers."
270   :type 'integer
271   :group 'riece-options)
272
273 (defcustom riece-max-buffer-size 65535
274   "Maximum size of channel buffers."
275   :type '(radio (integer :tag "Number of characters")
276                 (const nil))
277   :group 'riece-options)
278
279 (defcustom riece-format-time-function #'current-time-string
280   "Function to convert the specified time to the human readable form."
281   :type 'function
282   :group 'riece-options)
283
284 (provide 'riece-options)
285
286 ;;; riece-options.el ends here