cgit.sxemacs.org Git - riece/blob - 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-use-full-window t
  64   "If non-nil, whole Emacs window is used to display dialogue."
  65   :type 'boolean
  66   :group 'riece-looks)
  67
  68 (defcustom riece-window-center-line -2
  69   "Line number of center point in window when scrolling.
  70 If nil, erases the entire frame and then redraws with point in the
  71 center of the window.  Negative means relative to bottom of window.
  72 See the document of the function `recenter'."
  73   :type 'integer
  74   :group 'riece-looks)
  75
  76 (defcustom riece-directory (expand-file-name "~/.riece")
  77   "Where to look for data files."
  78   :type 'directory
  79   :group 'riece-options)
  80
  81 (defcustom riece-addon-directory
  82   (expand-file-name "addons" riece-directory)
  83   "Where to look for add-on files."
  84   :type 'directory
  85   :group 'riece-options)
  86
  87 (defcustom riece-variables-file
  88   (expand-file-name "init" riece-directory)
  89   "Where to look for variables."
  90   :type 'file
  91   :group 'riece-options)
  92
  93 (defcustom riece-saved-variables-file
  94   (expand-file-name "save" riece-directory)
  95   "Where to look for variables.
  96 This file was saved the last session."
  97   :type 'file
  98   :group 'riece-options)
  99
 100 (defcustom riece-variables-files
 101   (list riece-saved-variables-file riece-variables-file)
 102   "Where to look for variables.  Helps to remove clutter from your .emacs.
 103 This feature is most likely to dissappear in near future.  The preferred
 104 way is to put Riece variables on .emacs or file loaded from there."
 105   :type '(repeat (file :tag "Initialization File"))
 106   :group 'riece-options)
 107
 108 (defcustom riece-addons '(riece-highlight
 109                           riece-ctcp
 110                           riece-guess
 111                           riece-unread
 112                           riece-history
 113                           riece-url
 114                           riece-button
 115                           riece-menu
 116                           riece-icon
 117                           riece-ignore
 118                           riece-log
 119                           riece-toolbar
 120                           riece-alias
 121                           riece-ctlseq
 122                           riece-keyword)
 123   "Add-ons insinuated into Riece."
 124   :type '(repeat symbol)
 125   :group 'riece-options)
 126
 127 (defgroup riece-server nil
 128   "Server settings"
 129   :prefix "riece-"
 130   :group 'riece)
 131
 132 (defgroup riece-channel nil
 133   "Channel settings"
 134   :prefix "riece-"
 135   :group 'riece)
 136
 137 (define-widget 'riece-service-spec 'radio
 138   "Edit service spec entries"
 139   :convert-widget 'riece-service-spec-convert)
 140
 141 (defun riece-service-spec-convert (widget)
 142   (widget-put widget :args '((integer :tag "Port Number")
 143                              (string :tag "Name")))
 144   widget)
 145
 146 (define-widget 'riece-server-spec 'repeat
 147   "Edit server spec entries"
 148   :match (lambda (widget value)
 149            (eval `(and ,@(mapcar
 150                           (lambda (entry)
 151                             (or (stringp (cdr entry))
 152                                 (listp (cdr entry))))
 153                           value))))
 154   :convert-widget 'riece-server-spec-convert)
 155
 156 (defun riece-server-spec-convert (widget)
 157   (let* ((host '(const :format "" :value :host))
 158          (service '(const :format "" :value :service))
 159          (host
 160           `(group :inline t ,host (string :tag "Host")))
 161          (service
 162           `(group :inline t ,service riece-service-spec))
 163          (spec
 164           `(cons (string :tag "Name")
 165                  (radio (string :tag "Host")
 166                         (list ,host ,service))))
 167          (args (list spec)))
 168     (widget-put widget :args args)
 169     widget))
 170
 171 (defcustom riece-server-alist nil
 172   "An alist mapping server names to plist."
 173   :type 'riece-server-spec
 174   :group 'riece-server)
 175
 176 (defcustom riece-server (getenv "IRCSERVER")
 177   "IRC server host we are connecting to."
 178   :type 'string
 179   :group 'riece-server)
 180
 181 (defcustom riece-protocol 'irc
 182   "Protocol support."
 183   :type 'symbol
 184   :group 'riece-server)
 185
 186 (defcustom riece-max-send-size 512
 187   "Maximum size of messages to be sent at a time."
 188   :type 'integer
 189   :group 'riece-server)
 190
 191 (defcustom riece-send-delay 2
 192   "Duration of multiple send."
 193   :type 'integer
 194   :group 'riece-server)
 195
 196 (defcustom riece-default-password (getenv "IRCPASSWORD")
 197   "Your password."
 198   :type '(radio (string :tag "Password")
 199                 (const :tag "No" nil))
 200   :group 'riece-server)
 201
 202 (defcustom riece-username nil
 203   "Your user name."
 204   :type 'string
 205   :group 'riece-server)
 206
 207 (defcustom riece-nickname (or (getenv "IRCNICK")
 208                               (user-real-login-name))
 209   "Your nickname."
 210   :type 'string
 211   :group 'riece-server)
 212
 213 (defcustom riece-startup-channel-list nil
 214   "A list of channels to join automatically at startup."
 215   :type '(repeat (choice (string :tag "Channel")
 216                          (list (string :tag "Channel") (string :tag "Key"))))
 217   :group 'riece-channel)
 218
 219 (defcustom riece-startup-server-list nil
 220   "A list of servers to connect automatically at startup."
 221   :type '(repeat (string :tag "Server"))
 222   :group 'riece-server)
 223
 224 (defcustom riece-retry-with-new-nickname nil
 225   "When nickname has already been in use, grow-tail automatically."
 226   :type 'boolean
 227   :group 'riece-server)
 228
 229 (defcustom riece-quit-timeout 10
 230   "Quit timeout when there is no response from server."
 231   :type '(radio (integer :tag "Seconds")
 232                 (const nil))
 233   :group 'riece-server)
 234
 235 (defcustom riece-default-open-connection-function #'open-network-stream
 236   "Default function used for connecting to an IRC server."
 237   :type 'function
 238   :group 'riece-server)
 239
 240 (defcustom riece-channel-buffer-mode t
 241   "When non-nil, Riece will display a channel buffer."
 242   :type 'boolean
 243   :group 'riece-looks)
 244
 245 (defcustom riece-user-list-buffer-mode t
 246   "When non-nil, Riece will display a nick list buffer."
 247   :type 'boolean
 248   :group 'riece-looks)
 249
 250 (defcustom riece-channel-list-buffer-mode t
 251   "When non-nil, Riece will display a channel list buffer."
 252   :type 'boolean
 253   :group 'riece-looks)
 254
 255 (defcustom riece-default-freeze nil
 256   "Channel buffer local freeze flag is on at starting."
 257   :type 'boolean
 258   :group 'riece-looks)
 259
 260 (defcustom riece-default-channel-binding nil
 261   "The channel list to bind the channel number when joining."
 262   :type '(repeat (radio (string :tag "Bound Channel")
 263                         (const nil)))
 264   :group 'riece-channel)
 265
 266 (defcustom riece-blink-parens nil
 267   "Should we blink matching parenthesis in the command buffer?"
 268   :type 'boolean
 269   :group 'riece-options)
 270
 271 (defcustom riece-quit-message (riece-extended-version)
 272   "Default quit message."
 273   :type '(string :tag "Quit message")
 274   :group 'riece-options)
 275
 276 (defcustom riece-part-message nil
 277   "Default part message."
 278   :type '(choice (const :tag "No message" nil)
 279                  (string :tag "Part message"))
 280   :group 'riece-options)
 281
 282 (defcustom riece-away-message "Gone"
 283   "Default away message."
 284   :type '(string :tag "Away message")
 285   :group 'riece-options)
 286
 287 (defcustom riece-gather-channel-modes nil
 288   "If non-nil, gather channel modes when we join a channel."
 289   :type 'boolean
 290   :group 'riece-options)
 291
 292 (defcustom riece-buffer-dispose-function #'kill-buffer
 293   "Function called after the buffer was disposed."
 294   :type 'function
 295   :group 'riece-options)
 296
 297 (defcustom riece-shrink-buffer-idle-time-delay 5
 298   "Number of idle seconds to wait before shrinking channel buffers."
 299   :type 'integer
 300   :group 'riece-options)
 301
 302 (defcustom riece-max-buffer-size nil
 303   "Maximum size of channel buffers."
 304   :type '(radio (integer :tag "Number of characters")
 305                 (const nil))
 306   :group 'riece-options)
 307
 308 (defcustom riece-shrink-buffer-remove-chars (/ riece-max-send-size 2)
 309   "Number of chars removed when shrinking channel buffers."
 310   :type 'integer
 311   :group 'riece-options)
 312
 313 (defcustom riece-format-time-function #'current-time-string
 314   "Function to convert the specified time to the human readable form."
 315   :type 'function
 316   :group 'riece-options)
 317
 318 (provide 'riece-options)
 319
 320 ;;; riece-options.el ends here