vars.el.in 39.6 KB
Newer Older
Linus Tolke's avatar
Linus Tolke committed
1
;;;;; -*- emacs-lisp -*-
Linus Tolke's avatar
Linus Tolke committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
;;;;; $Id$
;;;;; Copyright (C) 1991  Lysator Academic Computer Association.
;;;;;
;;;;; This file is part of the LysKOM server.
;;;;; 
;;;;; LysKOM is free software; you can redistribute it and/or modify it
;;;;; under the terms of the GNU General Public License as published by 
;;;;; the Free Software Foundation; either version 1, or (at your option) 
;;;;; any later version.
;;;;; 
;;;;; LysKOM is distributed in the hope that it will be useful, but WITHOUT
;;;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
;;;;; FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
;;;;; for more details.
;;;;; 
;;;;; You should have received a copy of the GNU General Public License
;;;;; along with LysKOM; see the file COPYING.  If not, write to
;;;;; Lysator, c/o ISY, Linkoping University, S-581 83 Linkoping, SWEDEN,
;;;;; or the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, 
;;;;; MA 02139, USA.
;;;;;
;;;;; Please mail bug reports to bug-lyskom@lysator.liu.se. 
;;;;;
Per Cederqvist's avatar
.    
Per Cederqvist committed
25
26
27
28
29
30
31
32
33
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; File: vars.el
;;;;
;;;; This file contains almost all the variables used in lyskom.
;;;;


34
35
36
(defconst lyskom-clientversion-long 
  "$Id$\n"
  "Version for every file in the client.")
37
38


Per Cederqvist's avatar
.    
Per Cederqvist committed
39
40
41
42
43
44
45

(provide 'lyskom)


;;;; ================================================================
;;;;                    Emacs dependant variables

46
(defvar kom-emacs-knows-iso-8859-1 t
Per Cederqvist's avatar
.    
Per Cederqvist committed
47
  "*If non-nil then dont convert texts and other things to swascii.
David Byers's avatar
David Byers committed
48
49
50
This variable is not saved. It should be set in your .emacs

This variable is not saved in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
51
52
53
54
55
56
57
58
59
60
61
62
63


;;;; ================================================================
;;;;                     Variables and constants.


;;; User flags

(defvar kom-write-texts-in-window nil
  "*Nil means edit texts in the same window that is used for reading texts.
'other means edit in another window. Creating that window if necessary.
A buffer or buffer name means use the first window displaying that buffer.
If no window is displaying that buffer or the buffer does not exits then it
David Byers's avatar
David Byers committed
64
65
66
uses the same window.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
67

68
69
70
71
72
(defvar kom-cite-string ">"
  "*String to insert before each line of a commented text.

This variable is stored in the LysKOM server.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
73
(defvar kom-created-texts-are-read t
David Byers's avatar
David Byers committed
74
75
76
  "*Non-nil means automatically mark texts that you create as read.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
77

78
(defvar kom-dont-restore-window-after-editing nil
David Byers's avatar
David Byers committed
79
80
81
  "*If non-nil then don't restore the window configuration after sending a text.

This variable is not saved in the LysKOM server.")
82

Per Cederqvist's avatar
.    
Per Cederqvist committed
83
(defvar kom-default-mark 100
David Byers's avatar
David Byers committed
84
85
86
  "*If non-nil (must be an integer) then the user is not asked for type of mark.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
87
88

(defvar kom-reading-puts-comments-in-pointers-last t
David Byers's avatar
David Byers committed
89
90
91
  "*If Non-nil the texts are shown with comments references at the end.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
92
93

(defvar kom-dashed-lines t
David Byers's avatar
David Byers committed
94
95
96
  "*If Non-nil then all texts will be surrounded by lines of dashes.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
97
98
99

(defvar kom-print-number-of-unread-on-entrance t
  "*If Non-nil then print automatically the number of unread articles when
David Byers's avatar
David Byers committed
100
101
102
entering a conference.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
103
104
105
106

(defvar kom-presence-messages t
  "*If non-nil, lyskom prints continuous info about what other people are doing.
Info is printed on the message line and never in the buffer. If minibuffer is
Linus Tolke's avatar
Linus Tolke committed
107
108
109
used then no message is printed.

If you want the messages in the buffer you could set the variable 
David Byers's avatar
David Byers committed
110
111
112
kom-presence-messages-in-buffer.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
113
114
115
116
117

(defvar kom-presence-messages-in-buffer nil
  "*If t, lyskom prints information about what other people are doing in buffer.
All printing is done just before the prompt.
If nil no messages are printed.
118
If 'presence then messages about people logging in, out and people 
David Byers's avatar
David Byers committed
119
120
121
changing name is printed.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
122
123
124

(defvar kom-show-where-and-what t
  "*Non-nil means kom-who-is-on shows from which machine the user is running
David Byers's avatar
David Byers committed
125
126
127
and what he is doing.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
128

129
(defvar kom-show-footnotes-immediately t
David Byers's avatar
David Byers committed
130
131
132
  "*Non-nil means show footnotes immediately following the text.

This variable is stored in the LysKOM server.")
133

Per Cederqvist's avatar
.    
Per Cederqvist committed
134
135
(defvar kom-who-buffer-size-when-displaying 10
  "*Size of window to display the who-buffer.
David Byers's avatar
David Byers committed
136
137
138
This is used when executing the kom-display-who-buffer command.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
139
140

(defvar kom-read-depth-first t
David Byers's avatar
David Byers committed
141
142
143
  "*Non-nil means read comments and footnotes to a text before other texts.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
144
145
146
147
148

(defvar kom-higher-priority-breaks nil
  "*Non-nil means allow texts from conferences with highter priority to break in.
If the value is 'express then texts are allowed to break in the middle of a
comment chain.  Otherwise we dont let them in until the end of the comment
David Byers's avatar
David Byers committed
149
150
151
tree.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
152

David Kågedal's avatar
David Kågedal committed
153
(defvar kom-after-load-hook nil
David Byers's avatar
David Byers committed
154
155
156
  "Hook to run once after lyskom is loaded.

This variable is not saved in the LysKOM server.")
David Kågedal's avatar
David Kågedal committed
157

David Kågedal's avatar
David Kågedal committed
158
(defvar kom-login-hook nil
Per Cederqvist's avatar
.    
Per Cederqvist committed
159
160
  "*What to do when logged in.
This is a list of commands that are executed after we have logged in but before
David Byers's avatar
David Byers committed
161
162
163
any command is accepted from the keyboard.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
164

Linus Tolke's avatar
Linus Tolke committed
165
(defvar kom-do-when-done '(kom-review-all-marked-texts kom-display-time)
Per Cederqvist's avatar
.    
Per Cederqvist committed
166
167
168
169
170
171
172
173
174
  "*What to do when all texts are read.
This is a list of commands and lists of commands that are prompted for
and executed when there are no more new texts.  The last element in
the list is the one that will never be removed from the list.
A command can be one of:
type			prompt
lyskom-function		from the lyskom-command-name function.
command			\"Kommandot:\" name of function or definition of
			lambda expression
David Byers's avatar
David Byers committed
175
176
177
keyboard macro		\"Kommandot:\" keyboard macro definition.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
178

179
180
(defvar kom-page-before-command nil
  "*This is a list of all commands before which the screen is cleared.
David Byers's avatar
David Byers committed
181
182
183
If it isn't a list and isn't nil the screen is cleared before all commands.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
184
185
186
187
188
189

(defvar kom-membership-default-priority 100
  "*Default priority when joining a new conference.
If a valid priority then new conferences are read with this priority. 
Otherwise ask the user for a priority.

David Byers's avatar
David Byers committed
190
191
192
Valid priorities are only the range 0-255.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
193
194
195
196
197
198
199

(defvar kom-membership-default-placement 'last
  "*Tells the system where to put new conferences.
The value can be one of the following:
'first => before all other conferences.
'last => after all other conferences.
a number => at that position
David Byers's avatar
David Byers committed
200
201
202
otherwise => the new conf is entered after all conferences.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
203
204

(defvar lyskom-prompt-text " - "
David Byers's avatar
David Byers committed
205
206
207
  "*Text to end the prompt.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
208
209

(defvar lyskom-prompt-executing-default-command-text ". "
David Byers's avatar
David Byers committed
210
211
212
  "*Text to end the prompt while the default-commands is executing.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
213

Linus Tolke's avatar
Linus Tolke committed
214
(defvar lyskom-no-prompt nil
David Byers's avatar
David Byers committed
215
216
217
  "Tells the session that we have no prompt.

This variable is not saved in the LysKOM server.")
Linus Tolke's avatar
Linus Tolke committed
218

219
220
221
222
223
(defvar kom-show-personal-messages-in-buffer t
  "*Buffer to show personal messages in.
If nil, discard them.
If t, insert them in the *kom* buffert.
If non-nil and non-t this should be a buffer or a name of a (possibly
David Byers's avatar
David Byers committed
224
225
226
nonexistent) buffer in which the message is inserted.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
227

228
229
(defvar kom-pop-personal-messages nil
  "*Non-nil means pop up a buffer with personal messages as they arrive.
David Byers's avatar
David Byers committed
230
231
232
kom-show-personal-messages-in-buffer decides which buffer to pop.

This variable is stored in the LysKOM server.")
233

234
235
236
(defvar kom-ding-on-priority-break 1
  "*Non-nil means ding if a higher priority text or conference breaks in.
A number means the number of times to ding. A string is an argument for the
David Byers's avatar
David Byers committed
237
238
239
program named by kom-audio-player.

This variable is stored in the LysKOM server.")
240

241
242
243
244
245
246
247
248
(defvar kom-ding-on-wait-done 1
  "*Non-nil means ding when busy-waiting finishes.
A number means the number of times to ding. A string is an argument
for the program named by kom-audio-player. A symbol is interpreted as a 
function to call.

This variable is stored in the LysKOM server.")

249
(defvar kom-ding-on-common-messages 0
250
  "*Non-nil means ding as common messages arrive. 
251
A number means the number of times to ding. A string is an argument for the
252
253
program named by kom-audio-player. A symbol is interpreted as a function to
call.
David Byers's avatar
David Byers committed
254
255

This variable is stored in the LysKOM server.")
256
257

(defvar kom-ding-on-group-messages 1
258
  "*Non-nil means ding as group messages arrive.
259
A number means the number of times to ding. A string is an argument for the
260
261
program named by kom-audio-player. A symbol is interpreted as a function
to call.
David Byers's avatar
David Byers committed
262
263

This variable is stored in the LysKOM server.")
264
265

(defvar kom-ding-on-personal-messages 2
266
  "*Non-nil means ding as personal messages arrive.
267
A number means the number of times to ding. A string is an argument for the
268
269
program named by kom-audio-player. A symbol is interpreted as a function 
to call.
David Byers's avatar
David Byers committed
270
271
272
273
274

This variable is stored in the LysKOM server")

(defvar lyskom-ding-on-no-subject 2
  "How to ding if the user has not entered a subject line.
275
276
277
A number means the number of times to ding. A string is an argument for the
program named by kom-audio-player. A symbol is interpreted as a function 
to call.
David Byers's avatar
David Byers committed
278
279

This variable is not saved in the LysKOM server.")
280
281

(defvar kom-audio-player "audioplay"
David Byers's avatar
David Byers committed
282
283
284
  "*Program to play audio files.

This variable is not saved in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
285

David Byers's avatar
David Byers committed
286
287
288
289
(defvar kom-default-message-recipient 'group
  "*Determines default recipient of personal messages.

everybody means the default recipient is everybody.
David Byers's avatar
David Byers committed
290
291
292
293
294
group     means the default recipient is the group to which the last
          message was sent, if it was a group message. If the last message
          was a personal message or a common message, it means the same as 
          sender. 
sender    means the sender of the last message received.
David Byers's avatar
David Byers committed
295

David Byers's avatar
David Byers committed
296
This variable is stored in the LysKOM server.")
David Byers's avatar
David Byers committed
297

298
299
300

(defvar lyskom-filter-outgoing-messages t
  "t if outgoing remote-control messages and automatic replies are not
David Byers's avatar
David Byers committed
301
302
303
304
305
306
307
308
to be displayed in the buffer.

This variable is not saved in the LysKOM server.")

(defvar kom-friends nil
  "*List of people whose names should be formatted using kom-friends-face.

This variable is stored in the LysKOM server.")
309

David Byers's avatar
David Byers committed
310
311
312
313
314
315
316
317
318
(defvar kom-default-face-scheme
  (condition-case err
      (cond ((null window-system) 'default)
            ((not (x-display-color-p)) 'monochrome)
            ((eq (cdr (assoc 'background-mode (frame-parameters))) 'dark)
             'inverse)
            (t 'default))
    (error 'default))

David Byers's avatar
David Byers committed
319
320
321
322
  "*Face scheme to use per default for new logins.

This variable is not saved in the LysKOM server.")

323
324
(defvar kom-text-properties t
  "*Non-nil means to insert text properties in the Emacs buffer for
David Byers's avatar
David Byers committed
325
326
327
various LysKOM elements.

This variable is not saved in the LysKOM server.")
328

329
(defvar kom-use-button-hints t
David Byers's avatar
David Byers committed
330
331
332
  "*Non-nil means use button hints for overriding default actions.

This variable is not saved in the LysKOM server.")
333

David Byers's avatar
David Byers committed
334
335
336
337
;;;
;;; lyskom-button-actions has been moved to swedish-strings.el on account
;;; of there being a bunch of language-dependent strings in it.
;;;
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359


(defvar lyskom-text-buttons
  '(
    ;; Text numbers
    ("\\(\\<[0-9][0-9][0-9][0-9][0-9]*\\>\\)"       ; Match
     text                           				; Button type
     0                                              ; Portion that's a button
     1                                              ; Portion that's the arg
     nil                                            ; Face or nil (=default)
     )

    ;; URLs

    ("\\(file://\\|ftp://\\|gopher://\\|http://\\|https://\\|news:\\|wais://\\|mailto:\\|telnet:\\)[^\t \012
\"<>|\\]*[^\t \012
\"<>|.,!(){}?'`]" 
     url 0 nil kom-url-face)

    ;; JySKom enhancements

    ("<(m[|ö]te *\\([0-9]+\\)[^0-9]*)>" conf 0 1 nil)
    ("<(text *\\([0-9]+\\)[^0-9]*)>" text 0 1 nil)
    ("<(person *\\([0-9]+\\)[^0-9]*)>" pers 0 1 nil)
David Kågedal's avatar
David Kågedal committed
360
    )
361
362
363
364
365
366
  "List of buttons to install in the text mass of LysKOM objects. Each element is
a list consisting of REGEXP TYPE BUTTON-MATCH BUTTON-ARG-MATCH FACE.
REGEXP is the regexp to look for in the text.
TYPE is the button type. Valid button types are defined in lyskom-button-actions
BUTTON-MATCH is the number of the parenthesized expression that is the actual button.
BUTTON-ARG-MATCH is the number of the expression to used as the button argument.
David Byers's avatar
David Byers committed
367
368
369
FACE is the text face to apply to the button, or nil to use the default face.

This variable is not saved in the LysKOM server")
370
371
372
373
374


(defvar kom-url-viewer-preferences '("emacs"
				    "netscape"
				    "w3")
David Byers's avatar
David Byers committed
375

376
  "*LysKOM will attempt to use URL viewers in the order specified here.
David Byers's avatar
David Byers committed
377
378
379
380
381
382
383
384
385
386
387
388
389
kom-url-managers is a list of all available viewers. Note that the elements
are all strings.

When you select an URL, this list is used to determine which URL
viewer to use in the following manner: Each element is in turn matched
against the manager regexp for each manager in kom-url-managers, and the
first manager found that matches is used to display the URL.

See kom-url-managers for a list of all available URL viewers. See
kom-netscape-command and kom-mosaic-command for information specific 
to some URL viewers.

This variable is not saved in the LysKOM server.")
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416


(defvar kom-url-managers '(("w3" 
			    "\\(http\\|gopher\\|ftp\\)"
			    "Emacs W3" 
			    lyskom-view-url-w3)
			   ("netscape"
			    ".*"
			    "Netscape Navigator"
			    lyskom-view-url-netscape)
			   ("\\(emacs\\|dired\\)"
			    "\\(ftp\\|file\\)"
			    "dired"
			    lyskom-view-url-dired)
			   ("\\(emacs\\|telnet-mode\\)"
			    "telnet"
			    "emacs telnet"
			    lyskom-view-url-telnet)
			   ("\\(emacs\\|mail-mode\\)"
			    "mailto"
			    "mail-mode"
			    lyskom-view-url-mailmode)
			   ("mosaic"
			    "\\(http\\|gopher\\|ftp\\|mailto\\|news\\|wais\\|file\\|te|net\\)"
			    lyskom-view-url-mosaic))

  "List of URL managers. Each element is a list consisting of
David Byers's avatar
David Byers committed
417
418
419
420
421
(MANAGER-REGEXP PROTOCOLS NAME VIEW-FUNCTION). When LysKOM attempts to
view an URL, kom-url-viewer-preferences is scanned, and the URL
manager whose MANAGER-REGEXP first matches an element in
kom-url-viewer-preferences and whose PROTOCOLS matches the protocol of
the selected URL is used to view the URL by calling its VIEW-FUNCTION
David Byers's avatar
David Byers committed
422
423
424
with the URL and the manager entry as arguments.

This variable is not saved in the LysKOM server.")
425
426

(defvar kom-mosaic-command "/usr/local/bin/mosaic"
David Byers's avatar
David Byers committed
427
  "*Command to run to start Mosaic
428

David Byers's avatar
David Byers committed
429
430
431
432
433
434
435
436
437
438
439
440
441
442
This variable is not saved in the LysKOM server.")

(defvar kom-netscape-command "netscape"

  "*Command to run to start Netscape.

If a string, it should be a command that starts Netscape with no
arguments. If a list, the first element must be a command that starts
Netscape. The remaining elements are used as arguments to Netscape.

For instance, a value of \"netscape\" is valid, but \"netscape -d host:0\"
is not. Instead, the latter should be \(\"netscape\" \"-d\" \"host:0\"\)

This variable is not saved in the LysKOM server.")
443

444
445
446
(defvar kom-confirm-multiple-recipients t
  "*Non-nil means ask the user for confirmation about recipients.
When the user writes a comment to a text with more than one recipient
David Byers's avatar
David Byers committed
447
448
449
he gets a y-or-n-p question for all recipients.

This variable is stored in the LysKOM server.")
450

David Kågedal's avatar
David Kågedal committed
451
(defvar kom-max-buffer-size nil
David Byers's avatar
David Byers committed
452
453
454
  "*If non-nil, ensure that buffers won't grow any larger than this

This variable is not saved in the LysKOM server.")
David Kågedal's avatar
David Kågedal committed
455

David Byers's avatar
David Byers committed
456
(defvar lyskom-print-complex-dates (and (>= emacs-minor-version 29)
David Byers's avatar
David Byers committed
457
					(>= emacs-major-version 19))
458
459
460
  "If non-nil, print today and yesterday using a special format. Doesn't
work very well with Emacs 19.28 or older. You may want to set this to nil,
but never set it to non-nil explicitly.
David Byers's avatar
David Byers committed
461
462

This variable is not saved in the LysKOM server.")
463

David Kågedal's avatar
David Kågedal committed
464
(defvar kom-server-aliases
David Kågedal's avatar
David Kågedal committed
465
466
467
  '(("kom.lysator.liu.se" . "LysKOM")
    ("kom.ludd.luth.se" . "LuddKOM")
    ("rydkom.rydnet.lysator.liu.se" . "RydKOM")
David Kågedal's avatar
David Kågedal committed
468
469
470
    ("kom.csd.uu.se" . "CSD-KOM")
    ("striterax.medio.mh.se" . "MedioKOM")
    ("kom.mds.mdh.se" . "MdS-KOM"))
David Byers's avatar
David Byers committed
471
472
473
  "An alist mapping server names to shorter identification strings

This variable is not saved in the LysKOM server.")
David Kågedal's avatar
David Kågedal committed
474

David Byers's avatar
David Byers committed
475
476
477
478

(defvar kom-ansaphone-on nil
  "t if automatic replies to personal messages are in effect.")

479
480
481
482
483
484
485
486
(defvar lyskom-ansaphone-messages nil
  "Messages collected by the automatic reply facility.
The most recent message is the first message in the list.")


(defvar lyskom-ansaphone-when-set (current-time-string)
  "Time when the auto-reply facility was enabled.")

David Byers's avatar
David Byers committed
487
488

(defvar kom-remote-control t
David Byers's avatar
David Byers committed
489
490
491
  "*t if LysKOM may be remotely controlled.

This variable is stored in the LysKOM server.")
David Byers's avatar
David Byers committed
492
493
494
495

(defvar kom-remote-controllers nil 
  "*Persons who may control LysKOM using messages.By default you can
always control your own sessions. See kom-self-control for more
David Byers's avatar
David Byers committed
496
497
498
information.

This variable is stored in the LysKOM server.")
David Byers's avatar
David Byers committed
499
500
501

(defvar kom-self-control t
  "*If non-nil, remote control commands are accepted from sessions logged
David Byers's avatar
David Byers committed
502
503
504
in as the same user as the current session.

This variable is stored in the LysKOM server.")
David Byers's avatar
David Byers committed
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525

(defvar kom-ansaphone-replies
  '((group nil nil nil nil)
    (common nil nil nil nil))
  "*List of automatic replies to various messages.

A list of (MESSAGE-TYPE SENDER RECIPIENT TEXT REPLY)
    MESSAGE-TYPE is one of personal, group or common or nil
    SENDER is a list of integers or a single integer or nil
    RECIPIENT is a list of integers or a single integer or nil
    TEXT is a regular expression or nil
    REPLY is a string or nil

When an incoming message arrives and the auto-reply facility is on,
this list is checked for automatic replies. The message type, sender,
recipient and text of the incoming messages is matched against the 
elements of this list. If a match is found, the corresponding reply is
send. A nil in one of the message-type, sender, recipient or text
components in the list is taken to mean a wildcard. A null reply means
don't send a reply.

David Byers's avatar
David Byers committed
526
527
528
If none of the elements match, KOM-ANSAPHONE-DEFAULT-REPLY is sent.

This variable is not saved in the LysKOM server.")
David Byers's avatar
David Byers committed
529
530


531
532
(defconst lyskom-elisp-variables
  '(kom-ding-on-personal-messages
533
534
    kom-ding-on-group-messages
    kom-ding-on-common-messages
David Byers's avatar
David Byers committed
535
    kom-ding-on-priority-break
536
    kom-ding-on-wait-done
David Byers's avatar
David Byers committed
537
538
    kom-show-personal-messages-in-buffer
    kom-pop-personal-messages
539
540
541
542
543
544
545
546
547
548
549
550
    kom-do-when-done
    kom-higher-priority-breaks
    kom-login-hook
    kom-membership-default-placement
    kom-membership-default-priority
    kom-mercial 
    kom-page-before-command 
    kom-permanent-filter-list
    kom-presence-messages-in-buffer
    kom-quit-hook
    kom-show-where-and-what
    kom-who-buffer-size-when-displaying
David Byers's avatar
David Byers committed
551
    kom-default-message-recipient
552
    kom-write-texts-in-window
553
    kom-cite-string
554
555
    kom-remote-control
    kom-remote-controllers
David Byers's avatar
David Byers committed
556
    kom-self-control
557
    kom-ansaphone-default-reply
David Byers's avatar
David Byers committed
558
559
    kom-ansaphone-replies
    kom-show-footnotes-immediately
David Byers's avatar
David Byers committed
560
    kom-friends
561
562
563
564
565
566
567
568
    lyskom-fetch-map-nos
    lyskom-new-text-hook
    lyskom-prefetch-conf-tresh 
    lyskom-prefetch-confs
    lyskom-prefetch-texts
    lyskom-prompt-executing-default-command-text
    lyskom-prompt-text
    lyskom-who-info-has-changed-hook)
569
  "Tells the client what flags and hooks that are to be saved in the server.
Per Cederqvist's avatar
.    
Per Cederqvist committed
570
571
These are the flags that are saved in the elisp-client part of the server.")

572
(defconst lyskom-global-boolean-variables '(
Per Cederqvist's avatar
.    
Per Cederqvist committed
573
574
575
576
577
578
  kom-created-texts-are-read
  kom-dashed-lines
  kom-presence-messages
  kom-print-number-of-unread-on-entrance
  kom-read-depth-first
  kom-reading-puts-comments-in-pointers-last
579
  kom-confirm-multiple-recipients
Per Cederqvist's avatar
.    
Per Cederqvist committed
580
)
581
582
  "List of flags that are to be saved as booleans in the common block.

Per Cederqvist's avatar
.    
Per Cederqvist committed
583
584
Dont change this. These are defined by the protocol.")
				  
585
586
587
588
589
590
(defconst lyskom-global-non-boolean-variables '(
  kom-default-mark
)
  "List of flags that are to be saved in the common block.
These are the non-boolean ones. See: lyskom-global-boolean-variables.

591
Dont change these. These are defined by the protocol.")
592

Per Cederqvist's avatar
.    
Per Cederqvist committed
593
594
595
596
597

;;; ================================================================
;;;                  Internal variables and constants


598
(defconst lyskom-clientversion "@@CLIENTVERSION@@"
Per Cederqvist's avatar
.    
Per Cederqvist committed
599
600
601
602
603
604
605
606
607
608
609
  "Version of the LysKOM elisp client.")

(defconst lyskom-max-int 8388607
  "The largest int emacs, and thus this LysKOM client, can handle.")

(defvar lyskom-max-packet-size lyskom-max-int
  "The largest possible packet size that can be transmitted to a
TCP/IP connection. This should be unlimited, but in practise there
are systems that limits this. This variable is automatically adjusted
if any problems are detected.")

Linus Tolke's avatar
Linus Tolke committed
610
611
612
613
614
615
616
617
618
619
620
621
622
(defvar lyskom-do-when-done nil
  "Internal of kom-do-when-done.")

(defvar lyskom-do-when-starting nil
  "Internal of kom-do-when-starting.")

(defvar lyskom-list-of-edit-buffers nil
  "Keeps track of active edit-buffers.")

(defvar lyskom-sessions-with-unread nil
  "List of lyskom-sessions with unread texts.
This is not buffer-local.")

623
624
625
(defvar lyskom-sessions-with-unread-letters nil
  "List of lyskom-sessions with unread letters.
This is not buffer-local.")
Linus Tolke's avatar
Linus Tolke committed
626
627
628
629
630
631
632
633
634
635
636
637
638

(defvar lyskom-buffer nil
  "What is the lyskom-buffer we are connected to.")

(defvar output nil
  "Uaark. Just to omit a warning...")

(defvar lyskom-errno nil
  "Errno of last lyskom error.")

(defvar lyskom-parse-pos nil
  "Position of parsing.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
(defvar lyskom-unparsed-buffer nil
  "Buffer containing unparsed information from the server.")

(defvar lyskom-unparsed-marker nil
  "Here are we inserting now.")

(defvar lyskom-to-be-printed-before-prompt nil
  "Contains the strings to be printed out before the next prompt.")

(defvar lyskom-other-clients-user-areas nil
  "Contains the parts of the user areas of unknown klients.
The area is a pair: name . info (both strings).")

(defvar lyskom-pending-calls nil
  "Assoc-list of calls to LysKOM server that have not yet completed.
Each element on the list has the format
	(REF-NO . KOM-QUEUE)
REF-NO	   unique number assigned by lyskom-send-packet.
KOM-QUEUE is a kom-queue. (See lyskom-call-data).")

(defvar lyskom-output-queue nil
  "Pending output to the server.
At most lyskom-max-pending-calls calls are sent at once.")

(defvar lyskom-max-pending-calls 20
  "*Max number of calls that are transmitted to the server at once.
Extra calls are queued in lyskom-output-queue and sent when the replies
David Byers's avatar
David Byers committed
666
667
668
returns.

This variable is not saved in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
669
670
671
672
673
674
675
676
677
678
679
680
681
682

(defvar lyskom-number-of-pending-calls 0
  "Number of pending calls that are transmitted to the server.")

(defvar lyskom-ref-no 0
  "Next ref-no to use. These ref-nos are used to keep track of the
different packets.")

(defvar lyskom-pers-no 0
  "The pers-no of the current user.")

(defvar lyskom-session-no 0
  "Session number in the server for this connection")

David Kågedal's avatar
David Kågedal committed
683
684
685
(defvar lyskom-session-priority 0
  "*This sessions priority.
Only texts in conferences with a priority equal to or higher than this
David Byers's avatar
David Byers committed
686
687
688
will be shown.

This variable is not saved in the LysKOM server.")
David Kågedal's avatar
David Kågedal committed
689

Per Cederqvist's avatar
.    
Per Cederqvist committed
690
691
692
693
694
695
(defvar lyskom-proc nil
  "The process (network connection) that is associated with this buffer.")

(defvar lyskom-server-info nil
  "Info about the server")

696
697
(defvar lyskom-server-name ""
  "The name of the server")
Per Cederqvist's avatar
.    
Per Cederqvist committed
698

David Byers's avatar
David Byers committed
699
700
701
(defvar lyskom-who-info-cache nil
  "Cache of who info.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
702
703
(defvar lyskom-conf-cache nil
  "Cache of conference statuses.")
704
705
706

(defvar lyskom-uconf-cache nil
  "Cache of small conference statuses.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725

(defvar lyskom-pers-cache nil
  "Cache of person statuses.")

(defvar lyskom-text-cache nil
  "Cache of text statuses.")

(defvar lyskom-text-mass-cache nil
  "Cache of texts.")

(defvar lyskom-marked-text-cache nil
  "Cache of marks of all texts the current user has marked. ")

(defvar lyskom-who-info-cache nil
  "Cache of people presently logged in in LysKOM.")

(defvar lyskom-who-info-buffer nil
  "Buffer for the who info presentation.")

Linus Tolke's avatar
Linus Tolke committed
726
(defvar lyskom-who-info-buffer-is-on t
727
728
  "Says wether we are collecting who-information or not.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777

(defvar lyskom-is-parsing t
  "True when parsing a result.
This is used to prevent parallell parsing since the parser is not reentrant.")

(defvar lyskom-string-bytes-missing 0
  "Number of bytes missing in the unparsed buffer when parsing a string.
Set when parsing a string and there were not enough bytes in the buffer
with the unparsed bytes. This variable is used to prevent reparsing before 
the string is complete.
This variable is buffer-local in the unparsed-buffer.")

(defvar lyskom-last-viewed 0
  "Postition of the first char of the last line that the user has had
time to view. This is normally the pos of the first char of the prompt.")

(defvar lyskom-mode-map nil
  "Keymap used in LysKOM mode.")


(defvar lyskom-reading-list nil
  "List of articles to read in the current conference.
Each element is a read-info. Only one of the elements is of the type CONF.
This one is located last in the list (except for the elements of the type 
REVIEW, REVIEW-TREE or REVIEW-MARK).
When reading an article with comments a list of the comments is built
recursively if the flag kom-read-depth-first is non-nil.
This is to keep track of the reading order.
Articles can exist in several of the read-info elements. All unread articles
in the conference are always present in the CONF type entry in this list even
if also in other entries. (COMM-IN, FOOTN-IN)

Some powerful reviewing commands requires to construct a list of articles that
should be read. These use the type REVIEW. When reviewing trees and when
every viewed article is supposed to be followed by all its comments then the
type REVIEW-TREE is used.

The first element is a dummy.")

(defvar lyskom-to-do-list nil
  "List of conferences with unread texts.
Each element is a read-info. All have the type 'CONF and there is one for
every conference with unread articles that have been prefetched already.
The list is sorted in falling priority. 
When going to a conference the first element (the one with the highest
priority) is copied from this list to lyskom-reading-list.

The first element is a dummy.")

David Byers's avatar
David Byers committed
778
779
780
(defvar lyskom-quit-flag nil
  "A flag indicating if the filter was interrupted by C-g.
 It is set to the same value as quit-flag on filter exit.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
781

David Kågedal's avatar
David Kågedal committed
782
783
784
785
(defvar lyskom-inhibit-minibuffer-messages nil
  "A flag indicating whether asynchronous minibuffer messages are allowed.
If this variable is non-nil, no asynchronous messages will appear.")

David Kågedal's avatar
David Kågedal committed
786
787
788
(defvar lyskom-is-saving nil
  "A flag indicating whether the server is saving at the moment.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
789
790
791
;;; These variables control prefetch of conf-stats, text-stats and texts:

(defvar lyskom-prefetch-texts 3
David Byers's avatar
David Byers committed
792
793
794
  "*Number of texts to prefetch.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
795
796
797

(defvar lyskom-prefetch-conf-tresh 50
  "*If fewer than lyskom-prefetch-conf-tresh texts are known, ask for more
David Byers's avatar
David Byers committed
798
799
800
conf-stats from server.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
801
802

(defvar lyskom-prefetch-confs 10
David Byers's avatar
David Byers committed
803
804
805
  "*Number of confs to ask about at once when checking for unread texts.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
806
807
808

(defvar lyskom-fetch-map-nos 50
  "*Number of text-nos lyskom will fetch when fetching maps.
David Byers's avatar
David Byers committed
809
810
811
+++ This is not yet used everywhere.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
812

813
814
815
816
817
818
(defvar lyskom-fetch-membership-length 6
  "*Number of entries in the membership-list that is fetched at a time.
This should be optimized depending on how often you read lyskom and
the activity in the first groups in you membership list.

Best performance is achieved if you, when logging in, always have an unread
David Byers's avatar
David Byers committed
819
820
821
article in one of the first lyskom-fetch-membership-length conferences.

This variable is not saved in the LysKOM server.")
822

Per Cederqvist's avatar
.    
Per Cederqvist committed
823
824
825
826
827
828
(defvar lyskom-last-conf-fetched -1
  "Last conf asked about. Number on the list lyskom-membership.")

(defvar lyskom-last-conf-received -1
  "Last conf known about. See lyskom-last-conf-fetched.")

David Kågedal's avatar
David Kågedal committed
829
830
831
832
(defvar lyskom-last-conf-done -1
  "This variable has obscure uses. I'm not even sure it is necessary.")
;; See lyskom-rest.el for its use. I believe it almost duplicates
;; lyskom-last-conf-received in practical use.
Per Cederqvist's avatar
.    
Per Cederqvist committed
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853


(defvar lyskom-membership nil
  "Sorted membership-list of the logged in person.")

(defvar lyskom-unread-confs nil
  "List containing all unread confs.")

(defvar lyskom-dont-change-prompt nil
  "Non-nil during the entry of a text.")

(defvar lyskom-fetched-texts nil
  "List of texts that are prefetched.")

(defvar lyskom-command-to-do 'unknown
  "Atom describing what command to do. See the function lyskom-what-to-do.")

(defvar lyskom-is-waiting nil
  "If non-nil then this is the condition for the waiting to be stopped.
If t however just meaning user is waiting for a text with prompt.
It is a form that will be evaluated (using eval) every time the asynchronous
Per Cederqvist's avatar
Per Cederqvist committed
854
855
856
message \"new text\" is received.

This is used by the command kom-busy-wait.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
857
858
859
860
861
862
863
864
865
866

(defvar lyskom-current-conf 0
  "Current conference. 0 means user is not reading any conf.")

(defvar lyskom-current-text nil
  "Text-no of current text. nil means no text is current.")

(defvar lyskom-previous-text nil
  "Text-no of previous text.  Nil means no text.")

867
868
869
(defvar lyskom-normally-read-texts nil
  "Stack of texts that are read normally. Used for kom-review-last-normally-read.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
870
871
872
(defvar lyskom-current-subject ""
  "Current subject.")

873
874
875
876
877
878
(defvar lyskom-last-added-rcpt 0
  "The default conference when adding a recipient.")

(defvar lyskom-last-added-ccrcpt 0
  "The default conference when adding a ccrecipient.")

879
880
(defvar lyskom-saved-file-name (concat default-directory "kom-text")
  "The default file name when saving a lyskom-text.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
881
882
883
884

(defvar lyskom-mode-hook nil
  "Hook to run when lyskom-mode is entered.")

Linus Tolke's avatar
Linus Tolke committed
885
(defvar kom-quit-hook nil
David Byers's avatar
David Byers committed
886
887
888
  "Hook to run when the LysKOM session is correctly ended.

This variable is stored in the LysKOM server.")
Linus Tolke's avatar
Linus Tolke committed
889

890
(defvar kom-quit-when-idle t
David Byers's avatar
David Byers committed
891
  "Non-niil to automatically quit when LysKOM is full and the session is idle")
892

893
(defvar kom-permanent-filter-list nil
David Byers's avatar
David Byers committed
894
895
896
  "List of patterns to filter permanently

This variable is stored in the LysKOM server.")
897
898
899
900

(defvar kom-session-filter-list nil
  "List of patterns to filter during this session")

901

902
903
904
(defvar lyskom-filter-list nil
  "List of patterns that are filtered.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
905
906
907
908
909
910
(defvar lyskom-new-text-hook nil
  "*Hook to run when a new text is created.
This hook is run after the prompt is removed if it shall be changed but before
the text Text 4711 {r skapad! is printed in the message area. And before the
new prompt is printed.
If the text: Text 4711 {r skapad! should not be printed then the hook should 
David Byers's avatar
David Byers committed
911
912
913
set the local variable no-message non-nil.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
914
915
916

(defvar lyskom-who-info-has-changed-hook nil
  "*Hook to run every time the who-info-buffer has changed.
David Byers's avatar
David Byers committed
917
918
919
The hook is run with current-buffer the lyskom buffer, not the who-info-buffer.

This variable is stored in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
920

921
922
923
924
925
(defvar lyskom-personal-message-hook nil
  "*Hook to run when a personal message is received.
When the hook is run 'sender' is bound to the pers-stat of the sender
of the message (or possibly nil), 'recipient' is 0 if the message is a
public message and otherwise the pers-no of the user, and 'message' is
David Byers's avatar
David Byers committed
926
927
928
a string that holds the message.

This variable is not saved in the LysKOM server.")
929
930


Per Cederqvist's avatar
.    
Per Cederqvist committed
931
932
933
934
(defvar lyskom-executing-command t
  "Non-nil means the client is executing a command.
Most commands can't be interrupted by another command.")

935
936
937
(defvar lyskom-current-command nil
  "The command currently being executed.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
938
939
940
(defvar kom-low-priority -1
  "*Priority that the current conference are set to when they are
aborted. nil means don't alter priority. (That means that
David Byers's avatar
David Byers committed
941
942
943
kom-go-to-next-conf might go to the same conference again.)

This variable is not saved in the LysKOM server.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
944
945
946
947
948
949
950
951
952
953
954

(defvar lyskom-membership-is-read nil
  "T when the membership has been read.")

(defvar lyskom-is-writing nil
  "t when the user is writing a text.")

(defvar lyskom-debug-communications-to-buffer nil
  "Non-nil means all communications with the server is stored in a buffer.
The name is stored in lyskom-debug-communications-to-buffer-buffer.")
  
955
(defvar lyskom-debug-communications-to-buffer-buffer "*kom*-debugs"
Per Cederqvist's avatar
.    
Per Cederqvist committed
956
957
958
  "Name of the buffer to insert the communications with the server into if
lyskom-debug-communications-to-buffer is non-nil.")

959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
(defvar lyskom-blocking-process nil
  "The process the where the lyskom-session is.
If blocking-do is called from a buffer that is no well-connected to the 
lyskom-session, i.e. the lyskom-proc variable is not set, then this variable
has to be set for the blocking-do to be able to know what process to send
questions to. This is the case when called from the minibuffer when 
completing.")

(defvar lyskom-doing-default-command nil
  "Non-nil if LysKOM is executing the default command.")

(defvar lyskom-first-time-around nil
  "Non-nil if LysKOM is being entered for the first time.")

(defvar lyskom-format-experimental nil
  "If non-nil, LysKOM is likely to blow up in your face.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
975
976
977
978
979
980
981
982
983

(defvar lyskom-count-var 0
  "This variable is used for counting things in the client, such as
unread texts in list-unread.")


(defvar lyskom-is-administrator nil
  "This variable is t if the user is in administrator mode and nil otherwise.")

984
985
986
987
988
989
(defvar lyskom-emacs19-p nil
  "This variable is t if LysKOM is running in Emacs 19")

(defvar lyskom-last-personal-message-sender ""
  "Name of sender of last personal message received")

David Kågedal's avatar
David Kågedal committed
990
991
992
(defvar lyskom-last-group-message-recipient ""
  "Name of target for last group message received")

David Kågedal's avatar
David Kågedal committed
993
994
995
(defvar lyskom-is-new-user nil
  "An internal variable used in kom-start-anew")

David Byers's avatar
David Byers committed
996
(defvar lyskom-apo-timeout-s 1
David Byers's avatar
David Byers committed
997
  "Seconds timeout for accept-process-output")
David Byers's avatar
David Byers committed
998

David Byers's avatar
David Byers committed
999
1000
1001
(defvar lyskom-apo-timeout-ms nil
  "Microseconds timeout for accept-process-output")

David Byers's avatar
David Byers committed
1002
1003
1004
(defvar lyskom-dont-read-user-area nil
  "If non-nil the user area will not be read on login.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
1005

1006
1007
1008
;;;; lyskom-tell-phrases-validation-keyword-list
;;; This is a list of keywords for kom-tell-phrases.
;;; These are the only keywords that are allowed in kom-tell-phrases.
1009

1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
;;; To coders of the elisp-client:
;;; If you add/delete a reference to any of these keywords make sure
;;; you update these changes.

;;; To everyone:
;;; The kom-tell-phrases list is checked against this list when the
;;; client is loaded, i.e. by lyskom-tell-phrases-validate that causes
;;; an error if any keyword is not present or any non-keyword is
;;; present.

(defconst lyskom-tell-phrases-validation-keyword-list
1021
  '(
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
    (kom-tell-silence)
    (kom-tell-send)
    (kom-tell-login)
    (kom-tell-read)
    (kom-tell-1st-pres)
    (kom-tell-write-comment)
    (kom-tell-write-footnote)
    (kom-tell-write-letter)
    (kom-tell-write-reply)
    (kom-tell-write-text)
    (kom-tell-conf-pres)
    (kom-tell-recover)
    (kom-tell-wait)
    (kom-tell-regret)
    (kom-tell-review)
    (kom-tell-change-name)
    (kom-tell-change-supervisor)
    (kom-tell-next-lyskom)
1040
    )
1041
  "Users must not change this constant, but are encouraged to change
1042
1043
the value of  kom-tell-phrases  for fun.")

1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
;;; ================================================================
;;; Commands lists that are removed from extended command depending on
;;; administrator status.

(defconst lyskom-admin-removed-commands
  '(kom-enable-adm-caps))
(defconst lyskom-noadmin-removed-commands
  '(kom-disable-adm-caps kom-remove-motd kom-set-motd kom-shutdown-server))


Per Cederqvist's avatar
.    
Per Cederqvist committed
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
;;; ================================================================
;;;          Externally defined variables (environment)


(defvar lyskom-default-server "kom.lysator.liu.se"
  "*Default LysKOM server.")

(defvar lyskom-default-user-name nil
  "*Default LysKOM user name.")

(defvar lyskom-default-password nil
  "Default LysKOM PASSWORD.")
Linus Tolke's avatar
Linus Tolke committed
1066
1067
1068

(defvar mode-line-conf-name nil
  "Conf name that is present on the mode-line.")
David Kågedal's avatar
David Kågedal committed
1069
1070
1071
1072
1073
1074
1075
1076
1077

;;; ================================================================
;;;         Faces

(defmacro lyskom-make-face (name &rest body)
  (` (if (memq (, name) (face-list))
	 nil
       (,@ body))))

David Byers's avatar
David Byers committed
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
(put 'lyskom-make-face 'lisp-indent-function 1)


(defmacro when (expr &rest body)
  "Execute BODY if EXPR evaluates to non-nil"
  (list 'if expr (cons 'progn body)))

(put 'when lisp-indent-function 1)
(put 'when 'edebug-form-spec t)



;;
;; Set up default faces in case no face scheme is selected
;;

(defvar lyskom-face-schemes
  '((default
     (kom-active-face default "blue4" nil)
     (kom-url-face default "BlueViolet" nil)
     (kom-me-face bold "blue3" "lavender")
     (kom-highlight-face highlight nil)
     (kom-text-face default nil nil)
     (kom-subject-face default nil nil)
     (kom-text-no-face kom-active-face nil nil)
     (kom-friends-face default "blue3" "lavender")
     (kom-presence-face italic "dim gray" nil)
     (kom-first-line-face default nil nil))
    (inverse
     (kom-active-face default "lightblue" nil)
     (kom-url-face default "Moccasin" nil)
     (kom-me-face bold "gold" "black")
     (kom-highlight-face highlight nil nil)
     (kom-text-face default nil nil)
     (kom-subject-face default "Khaki" nil)
     (kom-text-no-face kom-active-face nil nil)
David Kågedal's avatar
David Kågedal committed
1114
     (kom-friends-face default "red" nil)
David Byers's avatar
David Byers committed
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
     (kom-presence-face italic "grey" nil)
     (kom-first-line-face default nil nil))
    (monochrome
     (kom-active-face default nil nil)
     (kom-url-face default nil nil)
     (kom-me-face bold nil nil)
     (kom-highlight-face highlight nil nil)
     (kom-text-face default nil nil)
     (kom-subject-face default nil nil)
     (kom-text-no-face kom-active-face nil nil)
     (kom-friends-face underline nil nil)
     (kom-presence-face italic nil nil)
     (kom-first-line-face default nil nil))
    (minimal
     (kom-active-face default nil nil)
     (kom-url-face default nil nil)
     (kom-me-face default nil "lavender")
     (kom-highlight-face highlight nil nil)
     (kom-text-face default nil nil)
     (kom-subject-face default nil nil)
     (kom-text-no-face default nil nil)
     (kom-friends-face default nil "alice blue")
     (kom-presence-face italic "dim gray" nil)
     (kom-first-line-face default nil nil))
    (highlight
     (kom-active-face default nil nil)
     (kom-url-face default nil "LemonChiffon1")
     (kom-me-face default nil "thistle")
     (kom-highlight-face highlight nil nil)
     (kom-text-face default nil nil)
     (kom-text-no-face default nil nil)
     (kom-friends-face default nil "misty rose")
     (kom-subject-face default nil nil)
     (kom-presence-face italic "dim gray" nil)
     (kom-first-line-face default nil "lavender")))
  "Face schemes for LysKOM.

This variable is an association list that defines the face and color
schemes in LysKOM. The car of each element is the scheme key, a
symbol, and the cdr is a list of face definitions. Each face
definition in tur, is a list of four elements: the face name, the base
face, foreground color and background color. When LysKOM defines a
face from such a specification, the base face is first copied and then
the foreground and background colors are set. If it permissible to
substitute nil for any element except the face name.

For instance, (kom-me-face bold \"yellow\" \"red\") will cause kom-me-face
to be bold with yellow text on a red background."
)

David Byers's avatar
David Byers committed
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
(defun lyskom-set-face-foreground (face color)
  (condition-case error
      (set-face-foreground face color)
    (error nil)))

(defun lyskom-set-face-background (face color)
  (condition-case error
      (set-face-background face color)
    (error nil)))


David Byers's avatar
David Byers committed
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
(defun lyskom-set-face-scheme (scheme)
  "Set the LysKOM color and face scheme to SCHEME. Valid schemes are listed
in lyskom-face-schemes."
  (let ((tmp (assoc scheme lyskom-face-schemes)))
    (if (and tmp (eq window-system 'x))
        (progn
          (mapcar 
           (function
            (lambda (spec)
              (copy-face (or (elt spec 1) 'default) (elt spec 0))
              (if (elt spec 2)
                  (lyskom-set-face-foreground (elt spec 0) (elt spec 2)))
              (if (elt spec 3)
                  (lyskom-set-face-background (elt spec 0) (elt spec 3)))))
           (cdr tmp))))))

(lyskom-set-face-scheme kom-default-face-scheme)
David Kågedal's avatar
David Kågedal committed
1193

David Kågedal's avatar
David Kågedal committed
1194