lyskom-rest.el 121 KB
Newer Older
David Byers's avatar
David Byers committed
1
;;;;; -*-coding: iso-8859-1;-*-
Linus Tolke's avatar
Linus Tolke committed
2
3
;;;;;
;;;;; $Id$
4
;;;;; Copyright (C) 1991, 1996  Lysator Academic Computer Association.
Linus Tolke's avatar
Linus Tolke committed
5
6
7
8
9
;;;;;
;;;;; 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 
10
;;;;; the Free Software Foundation; either version 2, or (at your option) 
Linus Tolke's avatar
Linus Tolke committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
;;;;; 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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; File: lyskom-rest.el
;;;;
;;;; This is the rest of what was once the entire source code of the
;;;; client. Now most of the source resides in other files. Eventually
;;;; the functions in here will be distributed out to other files.
;;;; Below follows the original header of the LysKOM elisp client:
;;;;
;;;; ================================================================
;;;;
;;;; Simple LysKOM elisp client.
;;;;
;;;; Originally written by Per Cederqvist.
;;;;
;;;; Heavily hacked by:
;;;;    Thomas Bellman
;;;;    Linus Tolke
;;;;    Inge Wallin
46
47
;;;;    David K}gedal
;;;;    David Byers
Per Cederqvist's avatar
.    
Per Cederqvist committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
;;;;   and others.
;;;;
;;;; Some ideas stolen from lpmud.el written by Lars Willf|r and Thomas Bellman
;;;;
;;;; Conventions:
;;;;
;;;;    All functions, variables etc follow one of these conventions:
;;;;		lyskom-		general functions.
;;;;		cache-		cache-routines.
;;;;		initiate-	call a service. (Might look up in cache)
;;;;		kom-		user kommands.
;;;;		lyskom-parse-	parse (part of) a reply from the server.
;;;;				these are found in parse.el
;;;;		lyskom-edit-	Things related to the editing of texts.
;;;;		{lyskom,kom}-edit-options-
;;;;				things related to editing options
;;;;				(found in flags.el)
;;;;		{lyskom,kom}-prioritize-
;;;;				things related to the prioritize
;;;;				buffer. The file is prioritize.el
;;;;		{lyskom,kom}-{completing-read,completing,complete}-
;;;;				things related to
;;;;				lyskom-completing-read. Found in
;;;;				completing-read.el 
;;;;		lyskom-*-hook   hooks.
;;;;
;;;;    Three plus-signs (+++) in the code marks a place where more
;;;;    work is needed.
;;;;

78
79
80
81
(eval-when-compile
  (require 'lyskom-command "command")
  (require 'lyskom-menus "menus")
  (require 'lyskom-clienttypes "clienttypes.el"))
David Kågedal's avatar
David Kågedal committed
82
83


84
85
86
87
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))

88
89
(lyskom-external-function find-face)

90

Per Cederqvist's avatar
.    
Per Cederqvist committed
91
92
93
94
95
96
97
;;;; ================================================================
;;;;                             New errors.


(put 'lyskom-protocol-error 'error-conditions
     '(error lyskom-error lyskom-protocol-error))
(put 'lyskom-protocol-error 'error-message
98
     "LysKOM protocol error")
Per Cederqvist's avatar
.    
Per Cederqvist committed
99
100
101
102

(put 'lyskom-internal-error 'error-conditions
     '(error lyskom-error lyskom-internal-error))
(put 'lyskom-internal-error 'error-message
103
     "Internal LysKOM error")
Per Cederqvist's avatar
.    
Per Cederqvist committed
104

David Kågedal's avatar
David Kågedal committed
105
106
107
(put 'lyskom-format-error 'error-conditions
     '(error lyskom-error lyskom-format-error))
(put 'lyskom-internal-error 'error-message
108
     "Internal LysKOM format error")
David Kågedal's avatar
David Kågedal committed
109

Per Cederqvist's avatar
.    
Per Cederqvist committed
110

111
112
113
114
115
116
;;; ================================================================
;;;             Global variables
;;;

(defvar lyskom-unread-mode-line nil)

Per Cederqvist's avatar
.    
Per Cederqvist committed
117
118
119
120
121
122
123
124
125
126
;;; ================================================================
;;;             Error reporting from a number of commands.
;;;

;;; Author: Inge Wallin



(defun lyskom-get-error-text (errno)
  "Get a string which is the error ERRNO in plain text."
127
128
129
130
131
  (or
   (lyskom-get-string-internal (intern (concat "error-"
					       (number-to-string errno)))
			       'lyskom-error-texts)
   (lyskom-format 'error-not-found errno)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
132

133
(defun lyskom-report-command-answer (answer)
Per Cederqvist's avatar
.    
Per Cederqvist committed
134
135
136
137
138
139
  "Handles a void return from call to the server."
  (if answer 
      (lyskom-insert-string 'done)
    (lyskom-insert-string 'nope)
    (lyskom-format-insert 'error-code
			  (lyskom-get-error-text lyskom-errno)
David Byers's avatar
David Byers committed
140
141
			  lyskom-errno))
  answer)
Per Cederqvist's avatar
.    
Per Cederqvist committed
142
143
144
145
146
147
148


;;; ----------------------------------------------------------------
;;; Author: Aronsson

(defun lyskom-tell-internat (key)
  "Same as lyskom-tell-server, but use a key to a list of phrases."
David Kågedal's avatar
David Kågedal committed
149
150
151
  ;; The server at Lysator produces a lot of network traffic. The
  ;; solution should to be less verbose. This is very interesting
  ;; anymore, anyway.
Per Cederqvist's avatar
.    
Per Cederqvist committed
152
153
154
155
156
157
  (lyskom-tell-server (lyskom-tell-string key)))



;;; Resume operation after a crash.

David Kågedal's avatar
David Kågedal committed
158
159
(defun kom-recover (&optional refetch)
  "Try to recover from an error.
160
161
If the optional argument REFETCH is non-nil, all caches are cleared and
`lyskom-refetch' is called."
David Kågedal's avatar
David Kågedal committed
162
  (interactive "p")
David Kågedal's avatar
Bugfix    
David Kågedal committed
163
  (lyskom-init-parse lyskom-buffer)
Per Cederqvist's avatar
.    
Per Cederqvist committed
164
165
  (setq lyskom-call-data nil)
  (setq lyskom-pending-calls nil)
David Kågedal's avatar
David Kågedal committed
166
167
168
169
170
  (setq lyskom-output-queues (make-vector 10 nil))
  (let ((i 0))
    (while (< i 10)
      (aset lyskom-output-queues i (lyskom-queue-create))
      (++ i)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
171
172
  (setq lyskom-number-of-pending-calls 0)
  (setq lyskom-is-parsing nil)
173
174
175
  (when refetch
    (clear-all-caches)
    (lyskom-refetch))
Per Cederqvist's avatar
.    
Per Cederqvist committed
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
  (lyskom-tell-internat 'kom-tell-recover)
  (lyskom-end-of-command))


;;; ================================================================
;;;                      Run default command.


;;; Author: Tommy Persson

(defun kom-page-next-command ()
  "Scroll the bottom to the top and run the next command if it should be run"
  (interactive)
  (if (pos-visible-in-window-p (point-max))
      (progn
191
	(goto-char (point-max))
Per Cederqvist's avatar
.    
Per Cederqvist committed
192
	(recenter 0)
Lars Willför's avatar
Lars Willför committed
193
	(lyskom-next-command))
Per Cederqvist's avatar
.    
Per Cederqvist committed
194
195
    (recenter 0)
    (move-to-window-line -1)
Lars Willför's avatar
Lars Willför committed
196
    (lyskom-set-last-viewed)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
197
198


199
;;; Author: Lars Willf|r
Per Cederqvist's avatar
.    
Per Cederqvist committed
200
201
202
203

(defun kom-next-command ()
  "Run next command or scroll one page."
  (interactive)
Lars Willför's avatar
Lars Willför committed
204
205
206
207
  (if (pos-visible-in-window-p (point-max))
      (lyskom-next-command)
    (move-to-window-line -1)
    (lyskom-set-last-viewed)
208
209
    (lyskom-scroll)
    (if (< (window-start) lyskom-last-viewed)
David Byers's avatar
David Byers committed
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
        (lyskom-xemacs-or-gnu
         (let ((overlay (make-extent 
                         lyskom-last-viewed
                         (save-excursion (goto-char lyskom-last-viewed)
                                         (end-of-line)
                                         (forward-char 1)
                                         (point)))))
           (set-extent-face overlay 'kom-mark-face)
           (add-timeout 2 
                        'delete-extent
                        overlay))
         (let ((overlay (make-overlay 
                         lyskom-last-viewed
                         (save-excursion (goto-char lyskom-last-viewed)
                                         (end-of-line)
                                         (forward-char 1)
                                         (point)))))
           (overlay-put overlay 'face 'kom-mark-face)
           (run-at-time 2 nil
                        'delete-overlay
                        overlay))))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
231
232
233
234
235

  
(defun kom-line-next-command ()
  "Run next command or scroll one line."
  (interactive)
Lars Willför's avatar
Lars Willför committed
236
237
238
239
240
  (if (pos-visible-in-window-p (point-max))
      (lyskom-next-command)
    (move-to-window-line 1)
    (lyskom-set-last-viewed)
    (lyskom-scroll)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
241
242


243
244
;;; Author: Per Cederqvist

Lars Willför's avatar
Lars Willför committed
245
(defun lyskom-next-command ()
246
  "Run next command."
247
  (let ((lyskom-doing-default-command t))
248
249
250
251
252
    (cond
     ((eq lyskom-command-to-do 'next-pri-text)
      (lyskom-view-priority-text))
     ((eq lyskom-command-to-do 'next-text)
      (kom-view-next-text))
David Byers's avatar
David Byers committed
253
254
     ((eq lyskom-command-to-do 'reedit-text)
      (kom-re-edit-next-text))
255
256
257
258
259
260
261
     ((eq lyskom-command-to-do 'next-conf)
      (kom-go-to-next-conf))
     ((eq lyskom-command-to-do 'next-pri-conf)
      (lyskom-go-to-pri-conf))
     ((eq lyskom-command-to-do 'when-done)
      (let ((command (lyskom-what-to-do-when-done)))
	(cond
David Byers's avatar
David Byers committed
262
263
	 ((or (stringp command)
              (vectorp command))
264
	  (execute-kbd-macro command))
David Byers's avatar
David Byers committed
265
266
         ((commandp command) (call-interactively command))
         (t (lyskom-start-of-command nil) (lyskom-end-of-command)))))
267
268
269
270
     ((eq lyskom-command-to-do 'unknown)
      (lyskom-insert
       (lyskom-get-string 'wait-for-server)))
     (t (signal 'lyskom-internal-error '(kom-next-command))))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
271
272
273
274
275
276
277
278


;;; ================================================================
;;;                              View text.


(defun kom-initial-digit-view ()
  (interactive)
279
280
  (setq unread-command-events (cons last-command-event
                                    unread-command-events))
Per Cederqvist's avatar
.    
Per Cederqvist committed
281
282
283
284
285
286
  (call-interactively 'kom-view nil))


(defun kom-view (text-no)
  "View text number TEXT-NO."
  (interactive "P")
287
288
289
290
291
292
293
294
295
296
297
298
299
300
  (unwind-protect
      (progn
	(let ((kom-page-before-command nil))
	  (lyskom-start-of-command 'kom-view)
	  (lyskom-tell-internat 'kom-tell-review)
	  )
	(if (setq text-no (cond ((null text-no) nil)
				((listp text-no) (car text-no))
				(t text-no)))
	    nil
	  (setq text-no (lyskom-read-number (lyskom-get-string 'review-text-q)
					    lyskom-current-text)))
	(if (or (not (listp kom-page-before-command))
		(memq 'kom-view kom-page-before-command))
David Kågedal's avatar
David Kågedal committed
301
	    (recenter 1))
302
303
304
305
	(lyskom-tell-internat 'kom-tell-review)
	(lyskom-format-insert 'review-text-no text-no)
	(lyskom-view-text text-no))
    (lyskom-end-of-command)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
306
307


David Byers's avatar
David Byers committed
308
309
310
311
312
313
314
315
316
317
318
319
320
;;;; ================================================================
;;;;                          Re-edit text

(def-kom-command kom-re-edit-next-text ()
  "Display a buffer containing a failed submission"
  (interactive)
  (let ((el (read-list->first lyskom-reading-list)))
    (set-read-list-del-first lyskom-reading-list)
    (if (buffer-live-p (read-info->misc el))
        (lyskom-display-buffer (read-info->misc el))
      (lyskom-format-insert 'text-buffer-missing))))


Per Cederqvist's avatar
.    
Per Cederqvist committed
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
;;;; ================================================================
;;;;                         View next text.


(defun kom-view-next-new-text ()
  "Display next new text (putting all review constructs at the end of this conf)."
  (interactive)
  (let ((len (read-list-length lyskom-reading-list))
	(finished nil))
    (while (and (not finished)
		(> len 1))
      (let ((type (read-info->type (read-list->first lyskom-reading-list))))
	(cond 
	 ((or (eq type 'REVIEW)
	      (eq type 'REVIEW-TREE)
	      (eq type 'REVIEW-MARK))
	  (read-list-rotate lyskom-reading-list))
	 ((or (eq type 'COMM-IN)
	      (eq type 'FOOTN-IN))
	  (set-read-list-del-first lyskom-reading-list))
	 (t 
	  (setq finished t))))
      (-- len)))
  (kom-view-next-text))


347
348
;;; Modified to handle filters

David Kågedal's avatar
David Kågedal committed
349
(def-kom-command kom-view-next-text ()
Per Cederqvist's avatar
.    
Per Cederqvist committed
350
351
  "Display next text (from lyskom-reading-list)."
  (interactive)
David Kågedal's avatar
David Kågedal committed
352
353
354
355
356
357
358
359
360
  (lyskom-tell-internat 'kom-tell-read)
  (let ((action 'next-text))
    (while (eq action 'next-text)
      (if (read-list-isempty lyskom-reading-list)
	  (progn
	    (if (/= 0 lyskom-current-conf)
		(lyskom-insert-string 'completely-read-conf)
	      (lyskom-insert-string 'not-in-any-conf))
	    (setq action nil))
361
	      
David Kågedal's avatar
David Kågedal committed
362
363
364
365
366
367
368
369
370
371
372
	(progn
	  (let* ((tri (read-list->first lyskom-reading-list))
		 (text-no (car (cdr (read-info->text-list tri))))
		 (type (read-info->type tri))
		 (priority (read-info->priority
			    (read-list->first lyskom-reading-list)))
		 (is-review-tree (eq type 'REVIEW-TREE))
		 (is-review (or (eq type 'REVIEW)
				(eq type 'REVIEW-MARK)
				is-review-tree))
		 (mark-as-read (not is-review)))
373
374
	    (when is-review
              (delq text-no (read-info->text-list tri))) ;First entry only
David Kågedal's avatar
David Kågedal committed
375
376
377
378
379
380
381
382
383
	    (setq action
		  (lyskom-view-text text-no mark-as-read 
				    (and kom-read-depth-first
					 (not is-review))
				    (read-info->conf-stat
				     (read-list->first
				      lyskom-reading-list))
				    priority
				    is-review-tree
384
385
386
				    (not is-review)
				    (or (eq type 'REVIEW)
					(eq type 'REVIEW-MARK))))
David Kågedal's avatar
David Kågedal committed
387
388
389
390
	    (if mark-as-read
		(lyskom-is-read text-no)
	      (read-list-delete-text nil lyskom-reading-list)
	      (read-list-delete-text nil lyskom-to-do-list))))))))
391
  
Per Cederqvist's avatar
.    
Per Cederqvist committed
392

393
;;; Modified to handle filters
Per Cederqvist's avatar
.    
Per Cederqvist committed
394

David Kågedal's avatar
David Kågedal committed
395
;; This is horribly ugly. It acts like a user command, but it isn't.
Per Cederqvist's avatar
.    
Per Cederqvist committed
396
(defun lyskom-view-priority-text ()
David Byers's avatar
David Byers committed
397
398
399
  "Display the first text from the next conference on the lyskom-to-do-list.

Cannot be called from a callback."
Per Cederqvist's avatar
.    
Per Cederqvist committed
400
  (lyskom-start-of-command 'kom-view-next-text)
David Kågedal's avatar
David Kågedal committed
401
402
403
404
405
406
407
408
409
410
411
412
  (unwind-protect
      (progn
	(lyskom-tell-internat 'kom-tell-read)
	(let* ((tri (read-list->first lyskom-to-do-list))
	       (priority (read-info->priority
			  (read-list->first lyskom-reading-list)))
	       (text-no (car (text-list->texts (read-info->text-list tri)))))
	  (lyskom-is-read text-no)
	  (lyskom-view-text text-no t nil (read-info->conf-stat tri) 
			    priority nil t))
	(lyskom-wait-queue 'main))
    (lyskom-end-of-command)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
413
414
415


(defun lyskom-is-read (text-no)
Per Cederqvist's avatar
Per Cederqvist committed
416
  "Remove TEXT-NO from the list of texts to read.
Per Cederqvist's avatar
.    
Per Cederqvist committed
417
Deletes TEXT-NO from lyskom-reading-list and lyskom-to-do-list.
Per Cederqvist's avatar
Per Cederqvist committed
418
419
420
Adds info in lyskom-membership.

This function only modifies the internal state of the client. It does
Per Cederqvist's avatar
Per Cederqvist committed
421
422
not mark the text as read in the server. That function is performed by
lyskom-mark-as-read."
Per Cederqvist's avatar
.    
Per Cederqvist committed
423
424
  (read-list-delete-text text-no lyskom-reading-list)
  (read-list-delete-text text-no lyskom-to-do-list)
David Byers's avatar
David Byers committed
425
  (initiate-get-text-stat 'main 'lyskom-is-read-handler text-no)
426
  (setq lyskom-normally-read-texts (cons text-no lyskom-normally-read-texts)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
427
428
429
430
431


(defun lyskom-is-read-handler (text-stat)
  "Update lyskom-membership for all recipients to TEXT-STAT."
  (lyskom-traverse
432
433
      misc (text-stat->misc-info-list text-stat)
    (if (or (eq 'RECPT (misc-info->type misc))
David Byers's avatar
David Byers committed
434
            (eq 'BCC-RECPT (misc-info->type misc))
435
	    (eq 'CC-RECPT (misc-info->type misc)))
436
437
	(let ((membership (lyskom-try-get-membership
			   (misc-info->recipient-no misc))))
438
439
440
441
442
	  (if membership
	      (set-membership->read-texts
	       membership
	       (vconcat (vector (misc-info->local-no misc))
			(membership->read-texts membership))))))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
443
444
445
446
447
448


;;; ================================================================
;;;                        Go to next conf.


449
(def-kom-command kom-go-to-next-conf ()
Per Cederqvist's avatar
.    
Per Cederqvist committed
450
451
452
453
454
  "Go to next conf.
Take first conf from lyskom-to-do-list and copy it to lyskom-reading-list.
Tell server what the user is doing. If the user is reading a conf it is
moved last on lyskom-to-do-list, with priority 0."
  (interactive)
455
456
457
  (when (lyskom-check-go-to-conf)
    (lyskom-maybe-move-unread t)
    (lyskom-go-to-next-conf)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
458
459
460
461
462
463
464


(defun lyskom-go-to-pri-conf ()
  "Go to the conf with higher priority.
This differs from kom-go-to-next-conf only in the place where the yet unread 
in the current conf is placed."
  (lyskom-start-of-command 'kom-go-to-next-conf)
465
466
467
468
  (when (lyskom-check-go-to-conf)
    (lyskom-maybe-move-unread nil)
    (lyskom-go-to-next-conf)
    (lyskom-end-of-command)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
469
470
471
472
473
474


(defun lyskom-go-to-next-conf ()
  "Actually go to the next conference on the lyskom-to-do-list"
  ;; Copy first element on lyskom-to-do-list to lyskom-reading-list.
  (if (not (read-list-isempty lyskom-to-do-list))
475
476
      (let ((conf-stat (read-info->conf-stat 
                        (read-list->first lyskom-to-do-list))))
477
478
479
480
481
482
483
        (if conf-stat
            (progn (lyskom-set-mode-line conf-stat)
                   (read-list-enter-first
                    (read-list->first lyskom-to-do-list)
                    lyskom-reading-list)
                   (lyskom-enter-conf conf-stat 
                                      (read-list->first lyskom-to-do-list)))
484
485
          (read-list-enter-first
           (read-list->first lyskom-to-do-list)
486
           lyskom-reading-list)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
487
    (lyskom-insert-string 'all-conf-unread-r)
488
    (lyskom-set-mode-line (lyskom-get-string 'all-conf-unread-s))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
489
490


491
(defun lyskom-maybe-move-unread (bury)
Linus Tolke's avatar
Linus Tolke committed
492
  "Empty the reading list.
493
If the argument BURY is non-nil and there are unread articles left in the
Linus Tolke's avatar
Linus Tolke committed
494
reading list then the conf is inserted last in the to do list."
Per Cederqvist's avatar
.    
Per Cederqvist committed
495
496
  (if (not (read-list-isempty lyskom-reading-list))
      (progn
497
	(if bury
Per Cederqvist's avatar
.    
Per Cederqvist committed
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
	    (let ((conf-no nil)
		  (r 0))
	      (while (and (not conf-no)
			  (< r (read-list-length lyskom-reading-list)))
		(if (eq (read-info->type (read-list->nth lyskom-reading-list 
							 r))
			'CONF)
		    (setq conf-no (conf-stat->conf-no 
				   (read-info->conf-stat
				    (read-list->nth lyskom-reading-list r))))
		  (++ r)))
	      (if conf-no
		  (progn
		    (read-list-delete-read-info conf-no lyskom-to-do-list)
		    (read-list-enter-first (read-list->nth lyskom-reading-list
							   r)
					   lyskom-to-do-list)
		    (read-list-rotate lyskom-to-do-list)))))
	(set-read-list-empty lyskom-reading-list))))


519
520
521
522
523
524
525
526
527
528
(defun lyskom-check-go-to-conf (&optional conf)
  "Check if it is OK to go to conf CONF (a conf-stat).
It is assumed that lyskom-pers-no is a member of the conference.
This function interacts with the buffer and the user.

If CONF is nil, check the first conf on the to-do list."
  (let* ((conf-stat (or conf
                        (read-info->conf-stat 
                         (read-list->first lyskom-to-do-list))))
         (mship (and conf-stat 
David Byers's avatar
David Byers committed
529
                     (lyskom-get-membership (conf-stat->conf-no conf-stat) t)))
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
         (type nil)
         (continue t))
    (when (and conf-stat mship)
      (setq type (membership->type mship))

      (when (membership-type->invitation type)
        ;;; State the invitation,give the user a chance to accept it
        ;;; Leave the conf if the user does not want it
        (lyskom-format-insert 'your-invited
                              conf-stat
                              (membership->created-by mship))
        (if (lyskom-j-or-n-p (lyskom-get-string 'accept-invitation))
            (progn
              (set-membership-type->invitation type nil)
              (initiate-set-membership-type 'main
                                            nil
                                            lyskom-pers-no
                                            (conf-stat->conf-no conf-stat)
                                            (membership->type mship))
              (setq continue t))
          (progn
            (lyskom-sub-member (blocking-do 'get-pers-stat lyskom-pers-no)
                               conf-stat)
            (setq continue nil)
            )))

      (when (membership-type->secret type)
        (lyskom-format-insert-before-prompt 'bug-secret-mship conf-stat))

      (when (membership-type->passive type)
        ;;; Offer the user a chance to become an active member
        ;;; If the offer is refused, boot the user off the conference
        (lyskom-format-insert 'enter-passive conf-stat)
        (setq continue nil)
        (if (lyskom-j-or-n-p (lyskom-format 'convert-passive conf-stat))
            (progn
              (set-membership-type->passive type nil)
              (initiate-set-membership-type 'main
                                            nil 
                                            lyskom-pers-no
                                            (conf-stat->conf-no conf-stat)
                                            (membership->type mship))
              (setq continue t))
          (progn
            (setq continue nil))))
      )
    
    ;;; Return the result
    continue))

Per Cederqvist's avatar
.    
Per Cederqvist committed
580
581
582
583
584
(defun lyskom-enter-conf (conf-stat read-info)
  "Tell server which conf the user is reading.
Prints the name and amount of unread in the conference we just went to 
according to the value of kom-print-number-of-unread-on-entrance.
Args: CONF-STAT READ-INFO"
David Byers's avatar
David Byers committed
585
586
587
  (lyskom-run-hook-with-args 'lyskom-change-conf-hook
                             lyskom-current-conf
                             (conf-stat->conf-no conf-stat))
588
589
  (unless lyskom-is-anonymous
    (initiate-pepsi 'main nil (conf-stat->conf-no conf-stat)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
590
  (setq lyskom-current-conf (conf-stat->conf-no conf-stat))
591
  (let ((num-unread (text-list->length (read-info->text-list read-info))))
592
    (lyskom-format-insert (if (not kom-print-number-of-unread-on-entrance)
593
594
595
596
597
598
                              'enter-conf
                            (if (= num-unread 1)
                                'one-unread
                              'several-unread))
                          conf-stat
                          num-unread)))  
Per Cederqvist's avatar
.    
Per Cederqvist committed
599

David Byers's avatar
David Byers committed
600
601
602
603
604
605
606
(defun lyskom-leave-current-conf ()
  "Leave the current conference without going to another one."
  (set-read-list-empty lyskom-reading-list)
  (lyskom-run-hook-with-args 'lyskom-change-conf-hook
                             lyskom-current-conf 0)
  (setq lyskom-current-conf 0)
  (initiate-pepsi 'main nil 0))
Per Cederqvist's avatar
.    
Per Cederqvist committed
607
608
609
610


;;;================================================================

611
612
613
;;; in vars.el:
;(defvar lyskom-sessions-with-unread nil
;  "Global variable. List of lyskom-sessions with unread articles.")
614
615
616
617
618
619
620
;;;Must be called after lyskom-get-string is defined. Also after running 
;;;load hooks.
;;;(or (assq 'lyskom-sessions-with-unread minor-mode-alist)
;;;    (setq minor-mode-alist (cons (list 'lyskom-sessions-with-unread 
;;;			       		  (lyskom-get-string 'mode-line-unread))
;;;				 minor-mode-alist)))

Per Cederqvist's avatar
.    
Per Cederqvist committed
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635

(defun lyskom-set-mode-line (&optional conf)
  "Sets mode-line-conf-name to the name of the optional argument conf CONF.
CONF can be a a conf-stat or a string."
  (let ((name (cond
	       ((null conf) 
		(if (zerop lyskom-current-conf)
		    (lyskom-get-string 'not-present-anywhere)
		  (initiate-get-conf-stat 'modeline 'lyskom-set-mode-line
					  lyskom-current-conf)
		  nil))
	       ((stringp conf) conf)
	       ((lyskom-conf-stat-p conf)
		(conf-stat->name conf))
	       (t "")))
636
        (conf-no (if (lyskom-conf-stat-p conf) (conf-stat->conf-no conf) 0))
Per Cederqvist's avatar
.    
Per Cederqvist committed
637
	(unread -1)
638
	(total-unread 0)
639
	(letters 0)
640
	(len 0)
Per Cederqvist's avatar
.    
Per Cederqvist committed
641
642
	(read-info-list nil))

643
      ;; Set unread to the number of unread texts in CONF.
David Byers's avatar
David Byers committed
644
    (setq read-info-list (read-list->all-entries lyskom-to-do-list))
645

David Byers's avatar
David Byers committed
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
    ;; This was weird. Someone had begun to write an if, but
    ;; this was all there was: (if 
    (while read-info-list
      (if (read-info->conf-stat (car read-info-list))
          (progn
            (setq len (text-list->length
                       (read-info->text-list (car read-info-list))))
            (if (= conf-no
                   (conf-stat->conf-no 
                    (read-info->conf-stat (car read-info-list))))
                (setq unread len))
            (if (= lyskom-pers-no
                   (conf-stat->conf-no 
                    (read-info->conf-stat (car read-info-list))))
                (setq letters len))
            (setq total-unread (+ total-unread len))))
      (setq read-info-list (cdr read-info-list)))
663
664
      (if (= unread -1)
	  (setq unread 0))
David Kågedal's avatar
David Kågedal committed
665
      
666
667
668
      (if (null name)
	  nil
	(setq mode-line-conf-name 
David Kågedal's avatar
David Kågedal committed
669
670
	      (substring (concat
			  (if (lyskom-conf-stat-p conf)
671
672
			      (if (not (eq lyskom-session-priority 
                                           kom-default-session-priority))
David Kågedal's avatar
David Kågedal committed
673
674
675
676
677
678
679
				  (format "(%d/%d:%d) "
					  unread total-unread
					  lyskom-session-priority)
				(format "(%d/%d) " unread total-unread))
			    "")
			  name
			  (make-string 27 ? ))
680
			 0 27)))
David Kågedal's avatar
David Kågedal committed
681
      
682
683
      (if (zerop total-unread)
	  (setq lyskom-sessions-with-unread
684
685
		(delq lyskom-buffer lyskom-sessions-with-unread))
	(or (memq lyskom-buffer lyskom-sessions-with-unread)
686
	    (setq lyskom-sessions-with-unread
687
		  (cons lyskom-buffer lyskom-sessions-with-unread))))
688
689
      (if (zerop letters)
	  (setq lyskom-sessions-with-unread-letters
690
691
		(delq lyskom-buffer lyskom-sessions-with-unread-letters))
	(or (memq lyskom-buffer lyskom-sessions-with-unread-letters)
692
	    (setq lyskom-sessions-with-unread-letters
David Byers's avatar
David Byers committed
693
		  (cons lyskom-buffer lyskom-sessions-with-unread-letters))))
David Kågedal's avatar
David Kågedal committed
694
    (force-mode-line-update)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
695
696
697
698
699
700


;;; ================================================================

;;; +++Where should this be moved???

David Byers's avatar
David Byers committed
701
(defun lyskom-try-get-membership (conf-no &optional want-passive)
Per Cederqvist's avatar
.    
Per Cederqvist committed
702
  "Returns non-nil if conference CONF-NO is present on lyskom-membership.
703
704
705
706
707
The value is actually the membership for the conference.

For foreground functions, lyskom-get-membership should probably be used
instead.

David Byers's avatar
David Byers committed
708
709
710
This function does not use blocking-do.

Optional argument mship-list is the membership list to look in."
Per Cederqvist's avatar
.    
Per Cederqvist committed
711
712
713
714
715
716
  (let ((list lyskom-membership)
	(found nil))
    (while (and (not found) (not (null list)))
      (if (= conf-no (membership->conf-no (car list)))
	  (setq found (car list)))
      (setq list (cdr list)))
David Byers's avatar
David Byers committed
717
718
719
720
721
    (if (and found
             (or want-passive
                 (not (membership-type->passive (membership->type found)))))
        found
      nil)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
722

David Byers's avatar
David Byers committed
723
(defun lyskom-get-membership (conf-no &optional want-passive)
724
725
726
727
  "Get the membership for CONF-NO, or nil if the user is not a member of
CONF-NO.

If the membership list is not fully prefetched and the membership can't be
728
found in lyskom-membership, a blocking call to the server is made."
David Byers's avatar
David Byers committed
729
  (or (lyskom-try-get-membership conf-no want-passive)
730
731
732
733
734
      (and (not (lyskom-membership-is-read))
	   (let ((membership
		  (blocking-do 'query-read-texts lyskom-pers-no conf-no)))
	     (if (and membership (lyskom-visible-membership membership))
		 (lyskom-add-membership membership conf-no))
David Byers's avatar
David Byers committed
735
736
737
738
739
740
    (if (and membership
             (or want-passive
                 (not (membership-type->passive
                       (membership->type membership)))))
        membership
      nil)))))
741
742


Per Cederqvist's avatar
.    
Per Cederqvist committed
743
744
745
746
;;;; ================================================================
;;;;                   Scrolling and text insertion.


David Kågedal's avatar
David Kågedal committed
747
748
749
750
751
(defun lyskom-trim-buffer ()
  "Trim the size of a lyskom buffer to lyskom-max-buffer-size"
  (save-excursion
    (if (and kom-max-buffer-size
	     (> (buffer-size) kom-max-buffer-size))
752
753
	(let ((delchars (- (buffer-size) kom-max-buffer-size))
	      (inhibit-read-only t))
David Kågedal's avatar
David Kågedal committed
754
755
756
757
758
	  (goto-char (point-min))
	  (while (< (point) delchars)
	    (forward-line 1))
	  (delete-region (point-min) (point))))))

Per Cederqvist's avatar
.    
Per Cederqvist committed
759
760
761
762
763
764
765
766
767
768
769
(defun lyskom-scroll ()
  "Scroll screen if necessary.
The position lyskom-last-viewed will always remain visible."
  ;; Find a window to scroll. Scroll the selected window if that shows LysKOM.
  ;; Otherwise scroll any window currently showing LysKOM.
  (let ((win
	 (cond
	  ((eq (window-buffer (selected-window)) (current-buffer))
	   (selected-window))
	  (t				;(get-buffer-window (current-buffer))
	   nil))))
Lars Willför's avatar
Lars Willför committed
770
771
772
773
774
775
776
777
778
779
    (if (and win			;Do nothing if no window showed LysKOM.
	     (not (pos-visible-in-window-p (point-max))))
	(progn
	  (goto-char (point-max))
	  (recenter -1)
	  (if (not (pos-visible-in-window-p lyskom-last-viewed))
	      (progn
		(set-window-start win lyskom-last-viewed)
		(move-to-window-line -1)
		(vertical-motion 1)
David Byers's avatar
David Byers committed
780
781
782
783
784
785
786
787
		(when (not (pos-visible-in-window-p))
		    (forward-char -1)
                    (when (> (current-column)
                             (window-width))
                      (backward-char (+ (- (current-column)
                                            (window-width))
                                        2)))
                    )))))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
788
	
David Byers's avatar
David Byers committed
789
790
791
792
793
794
795
796
797
798
799
;;;
;;; Thanks to the stupid danish fool who wrote the widget package, we
;;; have to do it this way, because w3 uses widgets, and because
;;; widgets use overlays, and because overlays aren't copied between
;;; buffers. If the idiot danish flaming asshole had used text
;;; properties or something equally sensible instead, we could have
;;; managed without this shit.
;;;
;;; (Me, upset? Why would you think *that*?)
;;;

Per Cederqvist's avatar
.    
Per Cederqvist committed
800

801
(defun lyskom-do-insert (string)
David Byers's avatar
David Byers committed
802
  (let ((start (point)))
803
804
805
806
807
808
809
810
811
812
813
814
    (insert string)
    (let ((bounds (next-text-property-bounds 1 (max 1 (1- start))
                                             'special-insert))
          (next (make-marker))
          (fn nil))
      (while bounds
        (set-marker next (cdr bounds))
        (setq fn (get-text-property (car bounds) 'special-insert))
        (remove-text-properties (car bounds) (cdr bounds)
                                '(special-insert))
        (condition-case val
            (funcall fn (car bounds) (cdr bounds))
David Byers's avatar
David Byers committed
815
          (error (apply 'message "%S" val)))
816
817
818
819
820
        (setq start next)
        (setq bounds (next-text-property-bounds 1 start
                                                'special-insert))))
    ))

David Byers's avatar
David Byers committed
821
822


Per Cederqvist's avatar
.    
Per Cederqvist committed
823
824
(defun lyskom-insert (string)
  "Insert STRING last in current buffer.
825
826
827
Leaves the point at the end of the buffer if possible without
scrolling past lyskom-last-viewed (generally the most recent prompt.)
Leaves the point at the end of the window if not possible. If buffer
828
is not on screen then doesn't move point."
829
  (when (symbolp string) (setq string (lyskom-get-string string)))
David Kågedal's avatar
David Kågedal committed
830
831
832
  (let ((was-at-max (= (save-excursion (end-of-line) (point)) (point-max))))
    (save-excursion
      (goto-char (point-max))
833
      (let ((inhibit-read-only t))
David Byers's avatar
David Byers committed
834
        (lyskom-do-insert string))
David Kågedal's avatar
David Kågedal committed
835
836
837
838
839
840
      (lyskom-trim-buffer))
    (let ((window (get-buffer-window (current-buffer))))
      (if (and window was-at-max)
	  (if (pos-visible-in-window-p (point-max) window)
	      (goto-char (point-max))
	    (and kom-continuous-scrolling (lyskom-scroll)))))))
841

Per Cederqvist's avatar
.    
Per Cederqvist committed
842

David Byers's avatar
David Byers committed
843

844
(defun lyskom-insert-at-point (string)
845
  "Insert STRING in the current buffer at point."
846
  (let ((inhibit-read-only t))
David Byers's avatar
David Byers committed
847
    (lyskom-do-insert string))
848
849
  (lyskom-trim-buffer))  

Per Cederqvist's avatar
.    
Per Cederqvist committed
850
851
852
853

(defun lyskom-insert-before-prompt (string)
  "Insert STRING just before the prompt of if no prompt then just buffers.
If prompt on screen then do the scroll if necessary.
854
The strings buffered are printed before the prompt by lyskom-update-prompt."
855
856
857
858
859
860
861
862
863
864
865
866
  ;;
  ;; This is the policy for moving point:
  ;;
  ;; old-point-max is the point-max before the text is inserted
  ;; new-point-max is the point-max after the text is inserted
  ;;
  ;; If point /= old-point-max, leave the point where it is, and don't
  ;; scroll the window.
  ;;
  ;; If point = old-point-max, set it to new-point-max, and if the
  ;; buffer is in a window, make sure that point is visible.
  ;;
Per Cederqvist's avatar
.    
Per Cederqvist committed
867
868
  (cond
   ((and lyskom-executing-command
869
         (not (eq lyskom-is-waiting t)))
Per Cederqvist's avatar
Per Cederqvist committed
870
871
    ;; Don't insert the string until the current command is finished.
    (if (null lyskom-to-be-printed-before-prompt)
872
        (setq lyskom-to-be-printed-before-prompt (lyskom-queue-create)))
873
    (lyskom-queue-enter lyskom-to-be-printed-before-prompt 
874
                        (list string)))
875
   (t
876
877
    ;; For some reaseon save-excursion doesn't work as expected
    (let ((oldpoint (point-marker)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
878
      (goto-char (point-max))
879
880
      (beginning-of-line)
      (let ((inhibit-read-only t))
David Byers's avatar
David Byers committed
881
	(lyskom-do-insert string))
882
      (goto-char oldpoint))
883
884
885
886
    (let ((window (get-buffer-window (current-buffer))))
      (if (and window
	       (not (pos-visible-in-window-p (point) window)))
	  ;; This mease that the prompt has been pushed off the bottom
887
888
889
	  (save-selected-window
	    (select-window window)
	    (recenter -1)))))))
890
      
Per Cederqvist's avatar
.    
Per Cederqvist committed
891
892
893
894
895

(defun lyskom-message (format-string &rest args)
  "Like message, but converts iso-8859/1 texts to swascii if necessary.
Args: FORMAT-STRING &rest ARGS"
  (let ((str (apply 'format format-string args)))
896
    (message "%s" str)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
897
898


899
900
901
902
(defun lyskom-error (format-string &rest args)
  "Like error, but converts iso-8859/1 texts to swascii if necessary.
Args: FORMAT-STRING &rest ARGS"
  (let ((str (apply 'format format-string args)))
903
    (error "%s" str)))
904
905


Lars Willför's avatar
Lars Willför committed
906
907
908
909
910
911
(defun lyskom-set-last-viewed ()
  (save-excursion
    (vertical-motion 0)
    (setq lyskom-last-viewed (point))))


Per Cederqvist's avatar
.    
Per Cederqvist committed
912
913
914
;;; ================================================================
;;;                  Extended string formatting

915
916
917
;;; Author: David Byers
;;; Original code: Inge Wallin

Per Cederqvist's avatar
.    
Per Cederqvist committed
918

919
(defvar lyskom-format-format
David Byers's avatar
David Byers committed
920
  "%\\(=\\)?\\(-?[0-9]+\\)?\\(#\\([0-9]+\\)\\)?\\(:\\)?\\(&\\)?\\([][@MmPpnrtsdoxcCSDF?]\\)"
921
  "regexp matching format string parts.")
Per Cederqvist's avatar
.    
Per Cederqvist committed
922
923
924

(defun lyskom-insert-string (atom)
 "Find the string corresponding to ATOM and insert it into the LysKOM buffer." 
David Byers's avatar
David Byers committed
925
926
927
 (if (stringp atom)
     (lyskom-insert atom)
   (lyskom-insert (lyskom-get-string atom))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
928

929
(defun lyskom-format (format-string &rest argl)
930
  (format-state->result (lyskom-do-format format-string argl)))
931
932

(defun lyskom-format-insert (format-string &rest argl)
933
934
  "Format and insert a string according to FORMAT-STRING.
The string is inserted at the end of the buffer with `lyskom-insert'."
935
  (let* ((state (lyskom-do-format format-string argl t))
David Kågedal's avatar
David Kågedal committed
936
937
938
	 ;; We have to use a marker, because lyskom-insert may trim
	 ;; the buffer size.
	 (start (point-max-marker))
939
	 (deferred (format-state->delayed-content state)))
940
    (lyskom-insert (format-state->result state))
941
942
943
944
945
946
    (while deferred
      (let ((defer-info (car deferred))
	    (m (make-marker)))
	(set-marker m (+ start (defer-info->pos defer-info)))
	(set-defer-info->pos defer-info m)			     
	(lyskom-defer-insertion defer-info)
David Kågedal's avatar
David Kågedal committed
947
948
	(setq deferred (cdr deferred))))
    (set-marker start nil)))
949

950
951
952
953
954
(defun lyskom-format-insert-at-point (format-string &rest argl)
  "Format and insert a string according to FORMAT-STRING.
The string is inserted at point."
  (let* ((state (lyskom-do-format format-string argl t))
	 (start (point))
955
	 (deferred (format-state->delayed-content state)))
956
    (lyskom-insert-at-point (format-state->result state))
957
958
959
960
961
962
963
    (while deferred
      (let ((defer-info (car deferred))
	    (m (make-marker)))
	(set-marker m (+ start (defer-info->pos defer-info)))
	(set-defer-info->pos defer-info m)			     
	(lyskom-defer-insertion defer-info)
	(setq deferred (cdr deferred))))))
964

965
(defun lyskom-format-insert-before-prompt (format-string &rest argl)
David Kågedal's avatar
David Kågedal committed
966
967
968
969
970
971
972
973
  "Format and insert a string according to FORMAT-STRING.
The string is inserted just before the prompt, and if the prompt is not
currently visible the text is queued to be inserted when the prompt
reappears.

Note that it is not allowed to use deferred insertions in the text."
  (lyskom-insert-before-prompt
   (format-state->result (lyskom-do-format format-string argl))))
974
975


David Kågedal's avatar
David Kågedal committed
976
(defun lyskom-do-format (format-string &optional argl allow-defer)
977
  "Do the actual formatting and return the resulting format-state."
978
979
980
981
982
983
984
985
  (let ((fmt (cond ((stringp format-string) format-string)
		   ((symbolp format-string) (lyskom-get-string 
					     format-string))))
	(state nil))
    (if (null fmt)
        (signal 'lyskom-internal-error (list 'lyskom-format-insert
                                             ": bad format string"))
      (save-excursion
David Kågedal's avatar
Bugfix    
David Kågedal committed
986
987
        (if (and (boundp 'lyskom-buffer)
		 lyskom-buffer)
David Kågedal's avatar
David Kågedal committed
988
            (set-buffer lyskom-buffer))
David Kågedal's avatar
David Kågedal committed
989
990
991
992
993
	(condition-case error
	    (setq state (lyskom-format-aux (make-format-state
					    fmt
					    0
					    argl
994
					    "")
David Kågedal's avatar
David Kågedal committed
995
					   allow-defer))
David Kågedal's avatar
David Kågedal committed
996
997
998
	  (lyskom-format-error
	   (error "LysKOM internal error formatting %s: %s%s"
		  format-string (nth 1 error) (nth 2 error))))))
999
    state))
1000
1001
1002



David Byers's avatar
David Byers committed
1003
1004
1005
1006
1007
;;;
;;; If you add a format letter, for goodness' sake, don't forget to
;;; att it to the regexp above too!
;;;

1008
1009


David Kågedal's avatar
David Kågedal committed
1010
(defun lyskom-format-aux (format-state allow-defer)
1011
1012
1013
1014
1015
1016
  (let ((format-length (length (format-state->format-string format-state)))
        (arg-no nil)
        (pad-length nil)
        (format-letter nil)
        (colon-flag nil)
        (equals-flag nil)
1017
        (face-flag nil)
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
        (abort-format nil))

    ;;
    ;;  Eat the format string bit by bit
    ;;

    (while (and (not abort-format)
                (< (format-state->start format-state)
                   format-length))

      ;;
      ;;    Look for a format letter. If there is none, finish up,
      ;;    otherwise handle each letter separately
      ;;

      (if (null (string-match lyskom-format-format
                              (format-state->format-string format-state)
                              (format-state->start format-state)))
          (progn
            (set-format-state->result 
             format-state
             (concat (format-state->result format-state)
                     (substring (format-state->format-string format-state)
                                (format-state->start format-state))))
            (set-format-state->start format-state
                                     (length (format-state->format-string
                                              format-state))))

        ;;
        ;; A format letter has been found
        ;;

        (set-format-state->result 
         format-state
         (concat (format-state->result format-state)
                 (substring (format-state->format-string format-state)
                            (format-state->start format-state)
                            (match-beginning 0))))

        (set-format-state->start format-state
                                 (match-end 0))

	(setq equals-flag (match-beginning 1)
1061
1062
1063
1064
1065
1066
1067
	      pad-length (if (match-beginning 2)
			     (string-to-int (substring 
					     (format-state->format-string
					      format-state)
					     (match-beginning 2)
					     (match-end 2)))
			   nil)
1068
	      arg-no (if (match-beginning 4)
1069
1070
1071
1072
1073
			 (string-to-int (substring (format-state->format-string
						    format-state)
						   (match-beginning 4)
						   (match-end 4)))
		       nil)
1074
	      colon-flag (match-beginning 5)
1075
1076
              face-flag (match-beginning 6)
	      format-letter (if (match-beginning 7)
1077
1078
				(aref (format-state->format-string 
				       format-state)
1079
				      (match-beginning 7))
1080
1081
1082
1083
			      (signal 'lyskom-internal-error
				      (list 'lyskom-format-aux 
					    (format-state->format-string
					     format-state)))))
1084

David Byers's avatar
David Byers committed
1085
1086
1087
1088
1089

        ;;
        ;;  If the format letter is an end-of-group letter, abort
        ;;  formatting and return to the caller.
        ;;
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103

	(if (= ?\] format-letter)
	    (progn 
	      (setq abort-format t)
	      (set-format-state->start format-state (match-end 0)))

	  (setq format-state 
            (lyskom-format-aux-help 
             format-state
             pad-length
             arg-no
             format-letter
             equals-flag
             colon-flag
1104
             face-flag
1105
1106
1107
1108
1109
             (if (and (match-beginning 2)
                      (eq (aref (format-state->format-string format-state)
                                (match-beginning 2))
                          ?0))
                 ?0
David Byers's avatar
David Byers committed
1110
               ?\ )
David Kågedal's avatar
David Kågedal committed
1111
	     allow-defer))))))
1112
1113
1114
1115
1116
1117
1118
1119
1120
  (lyskom-tweak-format-state format-state))


(defun lyskom-format-aux-help (format-state
                               pad-length
                               arg-no
                               format-letter
                               equals-flag
                               colon-flag
1121
                               face-flag
1122
                               pad-letter
David Kågedal's avatar
David Kågedal committed
1123
			       allow-defer)
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
  (let ((arg nil)
        (result nil)
        (propl nil)
        (prop-adjust-start 0)
        (prop-adjust-end 0)
        (oldpos (length (format-state->result format-state)))
        (abs-length (cond ((null pad-length) nil)
                          ((< pad-length 0) (- 0 pad-length))
                          (t pad-length))))
    (if (and arg-no 
             (< (format-state->args-length format-state) arg-no))
David Kågedal's avatar
David Kågedal committed
1135
        (signal 'lyskom-format-error (list 'lyskom-format
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
                                             ": too few arguments")))
    (if arg-no
        (setq arg (nth (1- arg-no) (format-state->args format-state))))
    
    (if (format-props-p arg)        
        (setq propl (format-props->propl arg)
              arg (format-props->arg arg)))
    
    
    (cond
     ;;
     ;;  Format a string or symbol by simply inserting it into the
     ;;  result list
     ;;
     ((= format-letter ?s)
      (setq result (cond ((stringp arg) arg)
                         ((symbolp arg) (symbol-name arg))
David Kågedal's avatar
David Kågedal committed
1153
                         (t (signal 'lyskom-format-error
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
                                    (list 'lyskom-format
                                          ": argument error"))))))
     ;;
     ;;  Format a number by conferting it to a string and inserting
     ;;  it into the result list
     ;;
     ((or (= format-letter ?d)
          (= format-letter ?o)
          (= format-letter ?x))
      (setq result (if (integerp arg)
                       (format (format "%%%c" format-letter)
                               arg)
                     (signal 'lyskom-internal-error
                             (list 'lyskom-format
                                   ": argument error")))))
     ;;
     ;;  Format a character by converting it to a string and inserting
     ;;  it into the result list
     ;;
     ((= format-letter ?c)
David Byers's avatar
David Byers committed
1174
1175
1176
1177
1178
      (setq result (cond ((integerp arg) (char-to-string (int-to-char arg)))
                         ((characterp arg) (char-to-string arg))
                         (t (signal 'lyskom-internal-error
                                    (list 'lyskom-format
                                          ": argument error"))))))
1179
1180
1181
1182
1183
1184
1185
     ;;
     ;;  Format a literal percent character by inserting a string
     ;;  containing it into the result list
     ;;
     ((= format-letter ?%)
      (setq result "%")) 
     
David Byers's avatar
David Byers committed
1186
1187
1188
1189
1190
1191
1192
1193
     ;;
     ;;  Format a command name somewhat specially
     ;;
     ((= format-letter ?C)
      (setq result (cond ((stringp arg) arg)
                         ((vectorp arg) 
                          (mapconcat 'single-key-description
                                     (append arg nil) " "))
David Byers's avatar
David Byers committed
1194
                         ((and arg (symbolp arg))
1195
                          (if (memq arg lyskom-commands)
David Byers's avatar
David Byers committed
1196
1197
			      (lyskom-command-name arg)
			    (prin1-to-string arg t)))
David Byers's avatar
David Byers committed
1198
                         (t (format "(%S)" arg)))))
David Byers's avatar
David Byers committed
1199
1200
1201
1202
1203
1204
1205

     ;;
     ;;  Format a sexp by princing it. Sort of.
     ;;
     ((= format-letter ?S)
      (setq result (format "%S" arg)))

1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
     ;;
     ;;  Format a text property array indicator by retreiving the
     ;;  properties from the argument list and adding a start of 
     ;;  new properties to the format state
     ;;
     ((= format-letter ?@)
      (set-format-state->delayed-propl
       format-state
       (cons (cons (length (format-state->result format-state))
                   arg)
             (format-state->delayed-propl format-state))))
     ;;
     ;;  Format a subformat list by recursively formatting the contents
     ;;  of the list, augmenting the result and format state
     ;;
David Kågedal's avatar
David Kågedal committed
1221
1222
1223
1224
1225
1226
1227
1228
     ;;  Idea: If this code used lyskom-do-format instead, we could
     ;;  use it to truncate a complex format by using a format string
     ;;  such as:  "%17[ %#1s will be truncated %]"
     ;;
     ;;  This could be useful for faster response when deferring
     ;;  printing. But this function would become more complex and
     ;;  slower.
     ;;
1229
     ((= format-letter ?\[)
David Kågedal's avatar
David Kågedal committed
1230
      (setq format-state (lyskom-format-aux format-state allow-defer)
1231
            result nil))
1232

David Byers's avatar
David Byers committed
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
     ;; A predicate
     ;; Get the predicate type and then parse the format string
     ;; accordingly

     ((= format-letter ?\?)
      (unless (string-match "[db]" 
                            (format-state->format-string format-state)
                            (format-state->start format-state))
        (lyskom-error "Unknown predicate in format string %s (%d)"
                      (format-state->format-string format-state)
                      (format-state->start format-state)))
      (set-format-state->start format-state (match-end 0))
      (let ((predicate-type (elt (match-string 0
                                 (format-state->format-string format-state))
                                 0)))
        (cond 

         ;; Plural/singular predicate
         ;; arg is an integer. Use the first subformat if it is one
         ;; and the second if it is other than one.
         ((= predicate-type ?d)
          (setq format-state
                (lyskom-format-do-binary-predicate (= arg 1)
                                                   format-state 
                                                   allow-defer)
                result nil))

         ;; True/false predicate
         ((= predicate-type ?b)
          (setq format-state
                (lyskom-format-do-binary-predicate arg
                                                   format-state
                                                   allow-defer)
                result nil))
         )))

1269
1270
1271
1272
1273
1274
     ((= format-letter ?F)
      (setq result 
            (if (lyskom-conf-stat-p arg)
                (let ((face (conf-stat-find-aux arg 9))
                      (string (copy-sequence "X")))
                  (lyskom-maybe-add-face-to-string face string))
David Byers's avatar
David Byers committed
1275
              " ")))
1276

1277
1278
1279
1280
1281
1282
1283
1284
     ;;
     ;;  Format a conference or person name by retreiving information
     ;;  about the conference or person and inserting it as a button
     ;;  (unless the colon flag is set)
     ;;
     ((or (= format-letter ?M)
          (= format-letter ?P))
      (setq result
David Kågedal's avatar
David Kågedal committed
1285
            (cond
1286
1287
1288
1289
1290
1291
             ;; The string is already supplied
             ((stringp arg) arg)

             ;; Conference 0 does not exist, and person 0 means anonymous
             ((and (integerp arg)
                   (zerop arg))
1292
	      (setq colon-flag t)
David Byers's avatar
X    
David Byers committed
1293
1294
1295
1296
1297
1298
1299
              (lyskom-format (cond ((= format-letter ?P)
                                    (or lyskom-default-pers-string
                                        'person-is-anonymous))
                                   ((= format-letter ?M)
                                    (or lyskom-default-conf-string
                                        'conference-does-not-exist)))
                             arg)
1300
	      )
1301
1302

             ;; Delay the printing
David Kågedal's avatar
David Kågedal committed
1303
             ((and allow-defer
1304
                   kom-deferred-printing
1305
                   (integerp arg))
1306
              (let ((tmp (cache-get-uconf-stat arg)))
1307
                (if (null tmp)
1308
                    (let* ((format-element
1309
			    (concat "%#2@%"
1310
1311
1312
1313
1314
1315
				    (if equals-flag "=" "")
				    (if pad-length (int-to-string pad-length))
				    "#1"
				    (if colon-flag ":" "")
				    (char-to-string format-letter)))
			   (defer-info (lyskom-create-defer-info
1316
					'get-uconf-stat
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
					arg
					'lyskom-deferred-insert-conf
					oldpos
					(if pad-length
					    (if equals-flag
						(abs pad-length)
					      (max (length
						    lyskom-defer-indicator)
						   (abs pad-length)))
					  (length lyskom-defer-indicator))
					format-element
					lyskom-default-conf-string)))
		      (set-format-state->delayed-content
1330
                       format-state
1331
                       (cons defer-info
1332
1333
                             (format-state->delayed-content
                              format-state)))
1334
                      lyskom-defer-indicator)
1335
1336
1337

                  ;; The conf-stat was in the cache

1338
                  (setq arg tmp)
1339
                  (uconf-stat->name arg)
1340
                  )))
David Kågedal's avatar
David Kågedal committed
1341
	     
1342
1343
             ;; The argument is an integer and we do not permit 
             ;; deferred printing
1344
             ((integerp arg)
1345
              (let ((conf-stat (blocking-do 'get-uconf-stat arg)))
1346
1347
1348
1349
1350
                (if (null conf-stat)
                    (lyskom-format (if (= format-letter ?P)
                                       'person-does-not-exist
                                     'conference-does-not-exist)
                                   arg)
1351
                  (uconf-stat->name conf-stat))))
David Kågedal's avatar
David Kågedal committed
1352
	     
1353
             ;; We got a conf-stat, and can use it directly
1354
             ((lyskom-conf-stat-p arg)
1355
1356
1357
1358
1359
              (if face-flag
                  (let ((face (conf-stat-find-aux arg 9)))
                    (lyskom-maybe-add-face-to-string face
                                                     (conf-stat->name arg)))
                (conf-stat->name arg)))
1360

1361
             ;; We have an uconf-stat
1362
1363
             ((lyskom-uconf-stat-p arg)
              (uconf-stat->name arg))
David Kågedal's avatar
David Kågedal committed
1364

1365
1366
1367