vars.el.in 24 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
37
38
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))


Per Cederqvist's avatar
.    
Per Cederqvist committed
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

(provide 'lyskom)


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

(defvar kom-emacs-knows-iso-8859-1 nil
  "*If non-nil then dont convert texts and other things to swascii.
This variable is not saved. It should be set in your .emacs")


;;;; ================================================================
;;;;                     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
uses the same window.")

(defvar kom-created-texts-are-read t
  "*Non-nil means automatically mark texts that you create as read.")

67
68
69
(defvar kom-dont-restore-window-after-editing nil
  "*If non-nil then don't restore the window configuration after sending a text.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
(defvar kom-default-mark 100
  "*If non-nil (must be an integer) then the user is not asked for type of mark.")

(defvar kom-reading-puts-comments-in-pointers-last t
  "*If Non-nil the texts are shown with comments references at the end.")

(defvar kom-dashed-lines t
  "*If Non-nil then all texts will be surrounded by lines of dashes.")

(defvar kom-print-number-of-unread-on-entrance t
  "*If Non-nil then print automatically the number of unread articles when
entering a conference.")

(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
86
87
88
89
used then no message is printed.

If you want the messages in the buffer you could set the variable 
kom-presence-messages-in-buffer.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
90
91
92
93
94

(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.
95
96
If 'presence then messages about people logging in, out and people 
changing name is printed.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
97
98
99
100
101

(defvar kom-show-where-and-what t
  "*Non-nil means kom-who-is-on shows from which machine the user is running
and what he is doing.")

102
103
104
(defvar kom-show-footnotes-immediately t
  "*Non-nil means show footnotes immediately following the text.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
105
106
107
108
109
110
111
112
113
114
115
116
117
(defvar kom-who-buffer-size-when-displaying 10
  "*Size of window to display the who-buffer.
This is used when executing the kom-display-who-buffer command.")

(defvar kom-read-depth-first t
  "*Non-nil means read comments and footnotes to a text before other texts.")

(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
tree.")

David Kågedal's avatar
David Kågedal committed
118
(defvar kom-login-hook nil
Per Cederqvist's avatar
.    
Per Cederqvist committed
119
120
  "*What to do when logged in.
This is a list of commands that are executed after we have logged in but before
David Kågedal's avatar
David Kågedal committed
121
any command is accepted from the keyboard.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
122

Linus Tolke's avatar
Linus Tolke committed
123
(defvar kom-do-when-done '(kom-review-all-marked-texts kom-display-time)
Per Cederqvist's avatar
.    
Per Cederqvist committed
124
125
126
127
128
129
130
131
132
133
134
  "*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
keyboard macro		\"Kommandot:\" keyboard macro definition.")

135
136
137
(defvar kom-page-before-command nil
  "*This is a list of all commands before which the screen is cleared.
If it isn't a list and isn't nil the screen is cleared before all commands.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

(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.

Valid priorities are only the range 0-255.")

(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
otherwise => the new conf is entered after all conferences.")

(defvar lyskom-prompt-text " - "
  "*Text to end the prompt.")

(defvar lyskom-prompt-executing-default-command-text ". "
  "*Text to end the prompt while the default-commands is executing.")

Linus Tolke's avatar
Linus Tolke committed
160
161
162
(defvar lyskom-no-prompt nil
  "Tells the session that we have no prompt.")

163
164
165
166
167
168
(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
nonexistent) buffer in which the message is inserted.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
169

170
171
172
173
174
175
176
(defvar kom-pop-personal-messages nil
  "*Non-nil means pop up a buffer with personal messages as they arrive.
kom-show-personal-messages-in-buffer decides which buffer to pop.")

(defvar kom-ding-on-personal-messages t
  "*Non-nil means ding as personal messages arrive.
Non-nil and non-t means only ding when they really are personal.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
177

178
(defvar kom-send-message-to-last-sender t
David Kågedal's avatar
David Kågedal committed
179
180
181
182
183
  "*Who to send messages to.
Non-nil means default recipient of messages is the sender of the last
personal message received. If the last message was a group message,
the default recipient will be the recipient of that message, unless
this variable is 'always. Nil means default is everybody.")
184

185
186
187
188
(defvar kom-text-properties t
  "*Non-nil means to insert text properties in the Emacs buffer for
various LysKOM elements.")

189
(defvar kom-text-buttons
David Kågedal's avatar
David Kågedal committed
190
191
192
193
194
195
196
197
198
  '(;; Ugly text number buttons. Has to come first.
    ("\\([0-9][0-9][0-9][0-9][0-9]*\\)" 
     text
     nil
     nil
     nil)

    ;; URL
    ("\\(file\\|ftp\\|gopher\\|http\\|https\\|news\\|wais\\|www\\|mailto\\|telnet\\):\\(//\\)?[^\t \012
\"<>|\\]*[^\t \012
\"<>|.,!(){}?'`]" 
199
200
201
202
203
     nil
     lyskom-button-follow-url
     nil
     (face kom-url-face mouse-face kom-highlight-face))
    
David Kågedal's avatar
David Kågedal committed
204
205
206
207
208
209
210
211
212
213
214
215
216
    ;; Let's be JySKom enhanced
    ("<(m[|ö]te *\\([0-9]+\\)[^0-9]*)>"
     conf nil nil nil)
    ("<(text *\\([0-9]+\\)[^0-9]*)>"
     text nil nil nil)
    ("<(person *\\([0-9]+\\)[^0-9]*)>"
     pers nil nil nil)
    )

  "*List of buttons to look for in texts.  Each element is a list of
(REGEXP TYPE FUNCTION ARGS PROPS) where REGEXP is the regular
expression to look for, TYPE is the type of button or nil, FUNCTION is
the function to call (or nil for typed buttons) and PROPS is a list of
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
text properties to add (or nil for typed buttons).

Button types may be conf, text or pers.")


(defvar kom-url-viewer-preferences '("emacs"
				    "netscape"
				    "w3")
  "*LysKOM will attempt to use URL viewers in the order specified here.
kom-url-managers is a list of all available viewers.")


(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
(MANAGER_REGEXP . VIEW_FUNCTION). Manager regexp is matched against
the user's kom-url-viewer setting.")
256
257
258
259

(defvar kom-mosaic-command "/usr/local/bin/mosaic"
  "*Command to run to start Mosaic")

260
261
(defvar kom-netscape-command "netscape")

262
263
264
265
266
(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
he gets a y-or-n-p question for all recipients.")

David Kågedal's avatar
David Kågedal committed
267
268
269
(defvar kom-max-buffer-size nil
  "*If non-nil, ensure that buffers won't grow any larger than this")

David Kågedal's avatar
David Kågedal committed
270
271
272
273
274
275
276
(defvar lyskom-server-aliases
  '(("kom.lysator.liu.se" . "LysKOM")
    ("kom.ludd.luth.se" . "LuddKOM")
    ("rydkom.rydnet.lysator.liu.se" . "RydKOM")
    ("kom.csd.uu.se" . "CSD-KOM"))
  "An alist mapping server names to shorter identification strings")

277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
(defconst lyskom-elisp-variables
  '(kom-ding-on-personal-messages
    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
    kom-write-texts-in-window
    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)
300
  "Tells the client what flags and hooks that are to be saved in the server.
Per Cederqvist's avatar
.    
Per Cederqvist committed
301
302
These are the flags that are saved in the elisp-client part of the server.")

303
(defconst lyskom-global-boolean-variables '(
Per Cederqvist's avatar
.    
Per Cederqvist committed
304
305
306
307
308
309
  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
310
  kom-confirm-multiple-recipients
Per Cederqvist's avatar
.    
Per Cederqvist committed
311
)
312
313
  "List of flags that are to be saved as booleans in the common block.

Per Cederqvist's avatar
.    
Per Cederqvist committed
314
315
Dont change this. These are defined by the protocol.")
				  
316
317
318
319
320
321
(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.

322
Dont change these. These are defined by the protocol.")
323

Per Cederqvist's avatar
.    
Per Cederqvist committed
324
325
326
327
328

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


329
(defconst lyskom-clientversion "@@CLIENTVERSION@@"
Per Cederqvist's avatar
.    
Per Cederqvist committed
330
331
332
333
334
335
336
337
338
339
340
  "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
341
342
343
344
345
346
347
348
349
350
351
352
353
(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.")

354
355
356
(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
357
358
359
360
361
362
363
364
365
366
367
368
369

(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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
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
417
(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
returns.")

(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")

(defvar lyskom-proc nil
  "The process (network connection) that is associated with this buffer.")

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

418
419
(defvar lyskom-server-name ""
  "The name of the server")
Per Cederqvist's avatar
.    
Per Cederqvist committed
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441

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

(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
442
(defvar lyskom-who-info-buffer-is-on t
443
444
  "Says wether we are collecting who-information or not.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493

(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 Kågedal's avatar
David Kågedal committed
494
495
496
(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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513

;;; These variables control prefetch of conf-stats, text-stats and texts:

(defvar lyskom-prefetch-texts 3
  "*Number of texts to prefetch.")

(defvar lyskom-prefetch-conf-tresh 50
  "*If fewer than lyskom-prefetch-conf-tresh texts are known, ask for more
conf-stats from server.")

(defvar lyskom-prefetch-confs 10
  "*Number of confs to ask about at once when checking for unread texts.")

(defvar lyskom-fetch-map-nos 50
  "*Number of text-nos lyskom will fetch when fetching maps.
+++ This is not yet used everywhere.")

514
515
516
517
518
519
520
521
(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
article in one of the first lyskom-fetch-membership-length conferences.")

Per Cederqvist's avatar
.    
Per Cederqvist committed
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
(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.")



(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
549
550
551
message \"new text\" is received.

This is used by the command kom-busy-wait.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
552
553
554
555
556
557
558
559
560
561

(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.")

562
563
564
(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
565
566
567
(defvar lyskom-current-subject ""
  "Current subject.")

568
569
570
571
572
573
(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.")

574
575
(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
576
577
578
579

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

Linus Tolke's avatar
Linus Tolke committed
580
581
582
(defvar kom-quit-hook nil
  "Hook to run when the LysKOM session is correctly ended.")

583
584
585
(defvar kom-quit-when-idle t
  "*Non-niil to automatically quit when LysKOM is full and the session is idle")

586
587
588
589
590
591
592
593
594
(defvar kom-permanent-filter-list nil
  "*List of patterns to filter permanently")

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

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

Per Cederqvist's avatar
.    
Per Cederqvist committed
595
596
597
598
599
600
601
602
603
604
605
606
(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 
set the local variable no-message non-nil.")

(defvar lyskom-who-info-has-changed-hook nil
  "*Hook to run every time the who-info-buffer has changed.
The hook is run with current-buffer the lyskom buffer, not the who-info-buffer.")

607
608
609
610
611
612
613
614
(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
a string that holds the message.")


Per Cederqvist's avatar
.    
Per Cederqvist committed
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
(defvar lyskom-executing-command t
  "Non-nil means the client is executing a command.
Most commands can't be interrupted by another command.")

(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
kom-go-to-next-conf might go to the same conference again.)")

(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.")
  
634
(defvar lyskom-debug-communications-to-buffer-buffer "*kom*-debugs"
Per Cederqvist's avatar
.    
Per Cederqvist committed
635
636
637
638
639
640
641
642
643
644
645
646
  "Name of the buffer to insert the communications with the server into if
lyskom-debug-communications-to-buffer is non-nil.")


(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.")

647
648
649
650
651
652
(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
653
654
655
(defvar lyskom-last-group-message-recipient ""
  "Name of target for last group message received")

Per Cederqvist's avatar
.    
Per Cederqvist committed
656

657
658
659
;;;; 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.
660

661
662
663
664
665
666
667
668
669
670
671
;;; 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
672
  '(
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
    (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)
691
    )
692
  "Users must not change this constant, but are encouraged to change
693
694
the value of  kom-tell-phrases  for fun.")

695
696
697
698
699
700
701
702
703
704
;;; ================================================================
;;; 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
705
706
707
708
709
710
711
712
713
714
715
716
;;; ================================================================
;;;          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
717
718
719

(defvar mode-line-conf-name nil
  "Conf name that is present on the mode-line.")