flags.el 17.8 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-2002  Lysator Academic Computer Association.
Linus Tolke's avatar
Linus Tolke committed
5
;;;;;
6
;;;;; This file is part of the LysKOM Emacs LISP client.
Linus Tolke's avatar
Linus Tolke committed
7
8
9
;;;;; 
;;;;; 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
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; File: flags.el
;;;;
;;;; This file contains code for editing the user variables and saving
;;;; them in the user area.
;;;;

35
36
37
38
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))

39
40
41
(eval-when-compile
  (require 'lyskom-command "command"))

42

43
44
(defvar lyskom-options-text nil
  "Text mass when reading options.")
45

David Byers's avatar
X    
David Byers committed
46
47
48
(def-kom-var lyskom-options-done nil
  "When we have read all options this is turned non-nil."
  local)
Linus Tolke's avatar
Linus Tolke committed
49

50
(def-kom-command kom-save-options ()
51
52
53
54
55
  "Save all LysKOM settings. This will save settings in the server but
not save anything to your Emacs init file (usually .emacs).

To edit settings, use `kom-customize'. This command can also save
settings to your emacs init file."
56
57
58
59
60
61
62
  (interactive)
  (lyskom-save-options (or lyskom-buffer 
                           (current-buffer))
                       (lyskom-get-string 'saving-settings)
                       (lyskom-get-string 'saving-settings-done)
                       (lyskom-get-string 'could-not-save-options)))

63
(def-kom-command kom-copy-options ()
64
65
66
67
68
69
70
  "Copy settings from one LysKOM session to another. This is useful if
you have configured on session to your liking and want ths settings to
be used on other servers as well.

This command will save settings to the LysKOM server, but will not
save anything to your Emacs init file. Use `kom-customize' to edit
settings and save them to your emacs init file."
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
  (interactive)
  (let* ((completions
          (mapcar (lambda (x)
                    (cons (save-excursion
                            (set-buffer x)
                            (buffer-name))
                          x))
                  (delq (or lyskom-buffer (current-buffer))
                        (copy-sequence lyskom-buffer-list))))
         (from-session (completing-read 
                        (lyskom-get-string 'session-to-copy-options-from)
                        completions
                        nil t)))
    (lyskom-message (lyskom-get-string 'reading-settings-from) from-session)
    (lyskom-read-options from-session)
    (lyskom-message (lyskom-get-string 'reading-settings-from-done) from-session)

    ;; Inline kom-save-options
    (lyskom-save-options (or lyskom-buffer (current-buffer))
                         (lyskom-get-string 'saving-settings)
                         (lyskom-get-string 'saving-settings-done)
                         (lyskom-get-string 'could-not-save-options))
))

95

96
97
98
99
100
101
102
103
104
;;;============================================================
;;;  lyskom-save-options
;;;
;;;  Save user-area without feedback in the KOM buffer. This
;;;  is for use by all functions but edit-options.
;;;
;;;  Messages are given in the minibuffer

(defun lyskom-save-options (kombuf start-message done-message error-message)
David Byers's avatar
David Byers committed
105
106
107
108
109
110
111
112
113
114
115
116
  ;; `kom-presence-messages' isn't used directly by the emacs lisp client.
  ;; Since there is much finer control of what presence messages to give
  ;; it's hard to encode this is a single boolean, so usually don't try.
  ;; Ony if the user sees all or no presence messages is it rather clear
  ;; what the common block value should be:
  (cond ((or (eq kom-presence-messages-in-buffer t)
 	     (eq kom-presence-messages-in-echo-area t))
 	 (setq kom-presence-messages t))
 	((not (or kom-presence-messages-in-buffer
 		  kom-presence-messages-in-echo-area))
 	 (setq kom-presence-messages nil)))

David Byers's avatar
David Byers committed
117
118
119
120
121
122
123
124
125
126
127
128
129
130
  (let* ((print-readably t)
         (common-block 
          (concat
           (mapconcat (function
                       (lambda (var)
                         (lyskom-format-objects
                          (substring (symbol-name var) 4) 
                          (if (symbol-value var) "1" "0"))))
                      lyskom-global-boolean-variables
                      "\n")
           "\n"
           (mapconcat (function
                       (lambda (var)
                         (lyskom-format-objects
131
                          (substring (symbol-name var) 4)
David Byers's avatar
David Byers committed
132
                          (lyskom-flag-value-to-string var))))
David Byers's avatar
David Byers committed
133
134
135
136
                      lyskom-global-non-boolean-variables
                      "\n")
           ))
         (elisp-block
137
138
139
140
141
142
          (mapconcat
	   (lambda (var)
	     (concat (format "%dH%s"
			     (length (symbol-name var))
			     (symbol-name var))
		     " "
David Byers's avatar
David Byers committed
143
		     (let* ((data (lyskom-flag-value-to-string var))
144
145
146
147
148
149
			    (coding 
			     (lyskom-mime-charset-coding-system
			      (lyskom-mime-string-charset data)))
			    (val (condition-case nil
				     (encode-coding-string data coding)
				   (error nil))))
150
                       (lyskom-ignore val)
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
		       (if (and val nil)
			   (format "%dC%s%dH%s"
				   (string-bytes (symbol-name coding))
				   (symbol-name coding)
				   (string-bytes val)
				   val)
			 (setq data
			       (encode-coding-string 
				data
				(or lyskom-server-coding-system 'raw-text)))
			 (format "%dH%s"
				 (string-bytes data)
				 data)))))
	   lyskom-elisp-variables
	   "\n")))
166
167
    (save-excursion
      (set-buffer kombuf)
168
      (lyskom-message "%s" start-message)
169
      (initiate-create-text
David Byers's avatar
David Byers committed
170
171
       'options 
       'lyskom-save-options-2
172
173
174
175
176
177
178
179
180
181
182
183
184
185
       (cons 'raw-text
	     (apply 'lyskom-format-objects
		    (apply 'lyskom-format-objects
			   "common"
			   "elisp"
			   (mapcar 
			    (lambda (el)
			      (cons 'STRING (cons 'raw-text (car el))))
			    lyskom-other-clients-user-areas))
		    (cons 'STRING (cons 'raw-text common-block))
		    (cons 'STRING (cons 'raw-text elisp-block))
		    (mapcar (lambda (el)
			     (cons 'STRING (cons 'raw-text (cdr el))))
			    lyskom-other-clients-user-areas)))
186
                            (lyskom-create-misc-list) 
David Byers's avatar
David Byers committed
187
188
189
190
191
192
                            (list
                             (lyskom-create-aux-item 
                              0 1 nil nil
                              (lyskom-create-aux-item-flags nil nil nil nil nil nil nil nil)
                              0
                              "x-kom/user-area"))
193
194
195
196
197
198
199
200
                            kombuf
                            done-message
                            error-message))))

(defun lyskom-save-options-2 (text-no kombuf done-message error-message)
  (if text-no
      (initiate-set-user-area 'options 'lyskom-save-options-3
                              lyskom-pers-no text-no kombuf 
201
                              done-message error-message text-no)
David Kågedal's avatar
typo    
David Kågedal committed
202
    (save-excursion
203
204
     (set-buffer kombuf)
     (lyskom-insert-string 'could-not-save-options)
205
     (lyskom-message "%s" (lyskom-get-string 'could-not-save-options)))))
206

207
208
(defun lyskom-save-options-3 (success kombuf done-message
                                      error-message text-no)
209
210
211
  (save-excursion
    (set-buffer kombuf)
    (if success
212
213
214
215
        (let ((pers-stat (cache-get-pers-stat lyskom-pers-no)))
          (when pers-stat
            (set-pers-stat->user-area pers-stat text-no))
          (setq lyskom-current-user-area text-no)
216
          (lyskom-message "%s" done-message))
217
      (lyskom-format-insert 'could-not-set-user-area lyskom-errno)
218
      (lyskom-message "%s" error-message))))
219

220
(defun lyskom-read-options (&optional buffer)
David Byers's avatar
David Byers committed
221
  "Reads the user-area and sets the variables according to the choises.
222
223
Returns a list of variables that were ignored. If optional BUFFER is
non-nil, read settings in that buffer."
Per Cederqvist's avatar
.    
Per Cederqvist committed
224
225
  (if (and lyskom-pers-no
	   (not (zerop lyskom-pers-no)))
226
227
228
229
      (let ((pers-stat 
             (save-excursion
               (when buffer (set-buffer buffer))
               (blocking-do 'get-pers-stat lyskom-pers-no))))
230
	(if (not pers-stat)             ;+++ Other error handler.
David Byers's avatar
David Byers committed
231
232
	    (progn (lyskom-insert-string 'you-dont-exist)
                   nil)
David Byers's avatar
X    
David Byers committed
233
	  (setq lyskom-other-clients-user-areas nil)
Per Cederqvist's avatar
.    
Per Cederqvist committed
234
	  (if (zerop (pers-stat->user-area pers-stat))
David Kågedal's avatar
David Kågedal committed
235
	      (progn
David Kågedal's avatar
David Kågedal committed
236
		;; (lyskom-tell-phrases-validate)
David Byers's avatar
David Byers committed
237
238
		(setq lyskom-options-done t)
                nil)
239
	    (lyskom-read-options-eval 
240
241
242
243
             (save-excursion
               (when buffer (set-buffer buffer))
               (blocking-do 'get-text
                            (pers-stat->user-area pers-stat)))))))
David Byers's avatar
David Byers committed
244
    nil))
Per Cederqvist's avatar
.    
Per Cederqvist committed
245
246

(defun lyskom-read-options-eval (text)
David Byers's avatar
David Byers committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
  "Handles the call from where we have the text.
Returns a list of variables that were ignored."
  (let ((ignored-user-area-vars nil))
    (condition-case nil
        (if text                        ;+++ Other error handler
            (let* ((lyskom-options-text (text->text-mass text))
                   (pointers (lyskom-read-options-eval-get-holerith t))
                   common-no elisp-no
                   (rest lyskom-options-text)
                   working
                   (r 1))
              (let* ((lyskom-options-text pointers)
                     word
                     (r 1))
                (while (> (length lyskom-options-text) 2)
                  (setq word (lyskom-read-options-eval-get-holerith t))
                  (cond
                   ((lyskom-string= word "common")
                    (setq common-no r))
                   ((lyskom-string= word "elisp")
                    (setq elisp-no r))
                   (t
                    ;; Build up lyskom-other-clients-user-areas so that it
                    ;; contains a list of pairs: (name . number). (string, int).
                    (setq lyskom-other-clients-user-areas
                          (cons (cons word r) lyskom-other-clients-user-areas))))
                  (++ r)))
              (setq lyskom-other-clients-user-areas 
                    (nreverse lyskom-other-clients-user-areas))
              (setq lyskom-options-text rest)
              (while (> (length lyskom-options-text) 2)
                (setq working (lyskom-read-options-eval-get-holerith t))
                (cond
                 ;; Note that common-no may be nil here, so the comparison
                 ;; cannot be performed with '=.
                 ((equal r common-no)
                  (let ((lyskom-options-text working)
                        name gname value)
                    (while (> (length lyskom-options-text) 2)
                      (setq gname (lyskom-read-options-eval-get-holerith))
                      (setq value (lyskom-read-options-eval-get-holerith))
                      (setq name (concat "kom-" gname))
                      (if (memq (intern-soft name) lyskom-global-boolean-variables)
                          (if (string= value "1")
                              (setq value "t")
                            (setq value "nil"))
                        (if (memq (intern-soft name) 
                                  lyskom-global-non-boolean-variables)
                            nil
                          (setq name (concat "UNK-" gname))
                          (setq lyskom-global-non-boolean-variables
                                (cons name lyskom-global-non-boolean-variables))))
                      (unless (lyskom-maybe-set-var-from-string name value)
                        (setq ignored-user-area-vars
                              (cons (intern gname) ignored-user-area-vars))))))
                 ;; Note that elisp-no may be nil here, so the comparison
                 ;; cannot be performed with '=.
                 ((equal r elisp-no)
                  (let ((lyskom-options-text working)
                        name value)
                    (while (> (length lyskom-options-text) 2)
                      (setq name (lyskom-read-options-eval-get-holerith))
                      (setq value (lyskom-read-options-eval-get-holerith))
                      (unless (lyskom-maybe-set-var-from-string name value)
                        (setq ignored-user-area-vars
                              (cons (intern name) ignored-user-area-vars))))))
                 (t
                  (let ((pos lyskom-other-clients-user-areas))
                    (while (and pos
                                (not (equal
                                      (cdr (car pos)) ;The position or the string.
                                      r)))
                      (setq pos (cdr pos)))
                    (if pos
                        (setcdr (car pos) working))))) ;Insert the string
322
323
					;where the position
					;was stored.
David Byers's avatar
David Byers committed
324
                (++ r))
325

David Byers's avatar
David Byers committed
326
327
              (mapcar 'lyskom-recompile-filter kom-permanent-filter-list)
              (mapcar 'lyskom-recompile-filter kom-session-filter-list)
David Byers's avatar
David Byers committed
328

David Byers's avatar
David Byers committed
329
330
331
332
333
334
335
336
337
338
339
340
              (setq lyskom-filter-list (append kom-permanent-filter-list
                                               kom-session-filter-list))
              (setq lyskom-do-when-done (cons kom-do-when-done kom-do-when-done))
              ;; Remove not found user-areas
              (let ((pos lyskom-other-clients-user-areas))
                (if pos
                    (progn
                      (while (stringp (cdr (car (cdr pos))))
                        (setq pos (cdr pos)))
                      (setcdr pos nil))))))
      (error (lyskom-message "%s" (lyskom-get-string 'error-in-options-short))))
    (setq lyskom-options-done t)
341
    (setq lyskom-current-user-area (if text (text->text-no text) 0))
David Byers's avatar
David Byers committed
342
    ignored-user-area-vars))
Per Cederqvist's avatar
.    
Per Cederqvist committed
343
344


David Byers's avatar
David Byers committed
345
346
(defun lyskom-read-options-eval-get-holerith (&optional no-coding)
  (let ((coding (if no-coding 'raw-text lyskom-server-coding-system)))
347
    (while (string-match "\\(\\s-\\|[\n\r]\\)" (substring lyskom-options-text 0 1))
David Byers's avatar
David Byers committed
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
      (setq lyskom-options-text (substring lyskom-options-text 1)))

    ;; Read the explicit coding, if any

    (when (string-match "^[0-9]+C" lyskom-options-text)
      (let ((len (string-to-int lyskom-options-text)))
        (setq coding (intern
                      (substring lyskom-options-text 
                                 (match-end 0)
                                 (+ (match-end 0) len))))
        (setq lyskom-options-text (substring lyskom-options-text
                                             (+ (match-end 0) len))))) 

    ;; Read the string

    (let ((len (string-to-int lyskom-options-text))
          (start (progn (string-match "[0-9]+H" lyskom-options-text)
                        (match-end 0))))
      (let ((name (substring lyskom-options-text start (+ start len))))
        (setq lyskom-options-text (substring lyskom-options-text
                                             (+ start len)))
        (condition-case nil
            (decode-coding-string name coding)
          (error name))))))
372

David Byers's avatar
David Byers committed
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
(defun lyskom-get-holerith (string &optional no-coding)
  "Get the first holerith string in STRING.
If optional NO-CODING is set, assume the string has internal coding."
  (let ((coding (if no-coding 'raw-text lyskom-server-coding-system)))

    ;; Strip initial whitespace

    (when (string-match "^\\(\\s-\\|[\n\r]\\)+" string)
      (setq string (substring string (match-end 0))))

    ;; Read the explicit coding, if any

    (when (string-match "^[0-9]+C" string)
      (let ((len (string-to-int string)))
        (setq coding (intern
                      (substring string 
                                 (match-end 0)
                                 (+ (match-end 0) len))))
        (setq string (substring string (+ (match-end 0) len)))))

    ;; Read the string

    (let ((len (string-to-int string))
          (start (progn (string-match "[0-9]+H" string)
                        (match-end 0))))
      (let ((name (substring string start (+ start len))))
        (setq string (substring string (+ start len)))
        (condition-case nil
            (cons (decode-coding-string name coding) string)
          (error (cons name string)))))))

David Byers's avatar
David Byers committed
404
405
(defun lyskom-maybe-set-var-from-string (var string)
  "This is a wrapper around lyskom-set-var-from-string that does nothing
David Byers's avatar
David Byers committed
406
407
408
409
410
if the variable is in kom-dont-read-saved-variables.

Return non-nil if the variable shouldn't have been set in the first place."
  (cond ((eq kom-dont-read-saved-variables t) t)
        ((memq (intern var) kom-dont-read-saved-variables) t)
411
        ((not (or (memq (intern var) lyskom-elisp-variables)
David Byers's avatar
David Byers committed
412
                  (memq (intern var) lyskom-global-non-boolean-variables)
David Byers's avatar
David Byers committed
413
414
                  (memq (intern var) lyskom-global-boolean-variables))) nil)
        (t (lyskom-set-var-from-string var string) t)))
David Byers's avatar
David Byers committed
415

416
417
418
419
420
(defun lyskom-set-var-from-string (var string)
  "This is a wrapper aroud read-from-string.
It returns nil, and writes a message when an error occurs."
  (set (intern var)
       (car
421
	(condition-case nil
422
423
	    (read-from-string string)
	  (invalid-read-syntax
David Kågedal's avatar
David Kågedal committed
424
425
	   (lyskom-format-insert (lyskom-get-string 'error-in-options)
				 var string)
426
	   nil)))))
David Byers's avatar
David Byers committed
427
428
429
430
431
432
433
434
435
436
437
438


(defun lyskom-flag-value-to-string (symbol)
  "Convert value of SYMBOL to a string."
  (cond ((eq symbol 'kom-permanent-filter-list)
         (prin1-to-string 
          (mapcar (lambda (filter)
                    (lyskom-create-filter (filter->pattern filter)
                                          (filter->attribute-list filter)
                                          nil))
                  kom-permanent-filter-list)))
        (t (prin1-to-string (symbol-value symbol)))))