-
Notifications
You must be signed in to change notification settings - Fork 34
/
Copy pathsawfish.el
1133 lines (995 loc) · 43.8 KB
/
sawfish.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
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
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
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
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
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
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; sawfish.el --- Sawfish mode.
;; Copyright 1999 - 2004 by Dave Pearson <[email protected]>
;; 2010 Sawfish Community
;; sawfish.el is free software distributed under the terms of the GNU
;; General Public Licence, version 2. For details see the file COPYING.
;;; Introduction:
;;
;; "sawfish.el" provides
;; * A major mode for writing Sawfish code.
;; This include symbol / var / func completion and help access,
;; both from doc-string and info file.
;; * sawfish-client wrapper, i.e. an interface to interact with
;; running Sawfish window manager.
;;
;; The latest sawfish.el is always available from:
;;
;; <URL:http://git.gnome.org/browse/sawfish/tree/sawfish.el>
;;; INSTALLATION:
;;
;; o Drop sawfish.el somwehere into your `load-path', e.g. site-lisp
;; directory (you might also want to byte-compile the file).
;;
;; o Add autoloads for the various sawfish functions to ~/.emacs. At the
;; very least you want to do something like:
;;
;; (autoload 'sawfish-mode "sawfish" "sawfish-mode" t)
;;
;; o Add the following to ~/.emacs to ensure that sawfish mode is used when
;; you go to edit sawfish code:
;;
;; (setq auto-mode-alist (cons '("\\.sawfishrc$" . sawfish-mode) auto-mode-alist)
;; auto-mode-alist (cons '("\\.jl$" . sawfish-mode) auto-mode-alist)
;; auto-mode-alist (cons '("\\.sawfish/rc$" . sawfish-mode) auto-mode-alist))
;;; List of commands:
;; o lisp evalutation:
;; sawfish-eval-region
;; sawfish-eval-buffer
;; sawfish-eval-defun
;; sawfish-eval-expression
;; sawfish-eval-last-sexp
;; sawfish-eval-print-last-sexp
;; o Sawfish counterparts of Emacs lisp helper
;; sawfish-describe-function
;; sawfish-describe-variable
;; sawfish-describe-function
;; sawfish-describe-variable
;; o others
;; sawfish-info-function, sawfish-info-variable:
;; Find the docstring of func / var from info.
;; sawfish-info, sawfish-rep-info:
;; View the sawfish / librep info file.
;; sawfish-console:
;; Open a buffer in which sawfish-client is run. (Think of `shell'.)
;; sawfish-interaction:
;; Sawfish version of lisp-interaction-mode
;; sawfish-load-symbols:
;; If you need an update of the list of sawfish symbols, e.g. for
;; sawfish-describe-variable or sawfish-describe-function,
;; call this.
;;; THANKS:
;;
;; John Harper <[email protected]> for help regarding sawfish and rep.
;;
;; Stefan Monnier for finding the font-lock (or lack of) with derived modes
;; problem and providing a fix for GNU Emacs.
;;
;; Jan Vroonhof for his invaluable pointers regarding XEmacs.
;;
;; Hubert Selhofer for the code to syntax highlight "#||#" comments, for the
;; GNU emacs font-lock code to provide support for various rep and sawfish
;; "keywords" and for the GNU emacs emacs-lisp menu removal kludge.
;;
;; Kai Grossjohann for his enhancments to `sawfish-console'.
;;
;; Markus Holmberg for the code that improves integration with info.
;;; BUGS:
;;
;; o The handling of the apropos buffer totally breaks down under XEmacs.
;;
;; o sawfish.el needs a total rewrite. When I started this mode librep
;; was an elisp-a-like. Since then it has turned into a
;; scheme-a-like that happens to retain some elisp-a-like
;; bits. Ideally a new sawfish.el would be written in terms of a
;; librep.el which would be a ground-up-rewritten mode for dealing
;; with rep.
;; o sawfish-pp is not complete. The challenge is that we want to
;; `read' sawfish sexp. It can fail if there're #f and #t. So
;; it's tried to replace them temporarily, but it may transform
;; say "#f".
;;; Code:
;; Wait for some 35 lines until defcustom...
;; Things we need:
(eval-when-compile
(require 'cl)
(require 'info))
(require 'thingatpt)
(require 'font-lock)
(require 'regexp-opt)
(require 'pp)
(require 'easymenu)
(require 'inf-lisp)
(require 'scheme)
(require 'lisp-mode)
;; Shut the compiler up.
(eval-when-compile
;; Keep everyone quiet.
(defvar sawfish-mode-map)
(defvar sawfish-mode-menu)
;; Things to keep XEmacs quiet.
(unless (boundp 'font-lock-defaults-alist)
(defvar font-lock-defaults-alist))
;; Things to keep GNU Emacs quiet.
(unless (boundp 'delete-menu-item)
(defun delete-menu-item (path)
nil)))
;; Attempt to handle older/other emacs.
(eval-and-compile
;; If customize isn't available just use defvar instead.
(unless (fboundp 'defgroup)
(defmacro defgroup (&rest rest) nil)
(defmacro defcustom (symbol init docstring &rest rest)
`(defvar ,symbol ,init ,docstring))))
;; Customize options.
(defgroup sawfish nil
"Mode for editing the configuration of and interacting with the sawfish
window manager."
:group 'languages
:prefix "sawfish-")
(defcustom sawfish-client "sawfish-client"
"*Command for interacting with the window manager."
:type 'string
:group 'sawfish)
(defcustom sawfish-exec-parameter "-e"
"*Parameter for `sawfish-client' that tells it to eval a form and exit."
:type 'string
:group 'sawfish)
(defcustom sawfish-interactive-parameter "-"
"*Interactive mode parameter for `sawfish-client'."
:type 'string
:group 'sawfish)
(defcustom sawfish-result-buffer "*sawfish*"
"*Name of the long result display buffer."
:type 'string
:group 'sawfish)
(defcustom sawfish-help-buffer "*sawfish-help*"
"*Name of the sawfish help buffer."
:type 'string
:group 'sawfish)
(defcustom sawfish-apropos-buffer "*sawfish-apropos*"
"*Name of the sawfish apropos buffer."
:type 'string
:group 'sawfish)
(defcustom sawfish-scratch-buffer "*sawfish-scratch*"
"*Name of the sawfish scratch buffer."
:type 'string
:group 'sawfish)
(defcustom sawfish-buffer-symbol-lists t
"*Cache the lists of function and variable names?"
:type 'boolean
:group 'sawfish)
(defcustom sawfish-apropos-searches-info-files t
"*Search info files for apropos \"one-liner\" help?
This variable controls the action of the sawfish apropos functions. When nil
the apropos functions won't go looking in the sawfish info files for a
one-line doc-string to display in the apropos buffer if the symbol doesn't
have a doc-string. This will make apropos calls a lot faster."
:type 'boolean
:group 'sawfish)
(defcustom sawfish-mode-hook nil
"*List of hooks to execute on entry to sawfish-mode."
:type 'hook
:group 'sawfish)
(defcustom sawfish-info-files '(("sawfish" "Function Index" "Variable Index")
("librep" "Function Index" "Variable Index"))
"*List of info files to search when looking for info documentation.
This is a list of lists. Each entry in the list is of the format:
(INFO-FILE FUNCTION-INDEX VARIABLE-INDEX)"
:type '(repeat (list :tag "Info file information"
(string :tag "Info file name")
(string :tag "Function index name")
(string :tag "Variable index name")))
:group 'sawfish)
(defcustom sawfish-comint-prompt "^sawfish% "
"*Regular expression for matching the sawfish-client prompt."
:type 'regexp
:group 'sawfish)
(defcustom sawfish-extra-keyword-list
'("add-frame-style" "call-after-load" "call-after-property-changed"
"call-after-state-changed" "custom-set-property")
"List of extra keywords for Sawfish used in highlighting.
Highlight these expressions with `font-lock-keyword-face'."
:group 'sawfish
:type '(repeat (string :tag "Keyword: ")))
(defcustom sawfish-warning-keyword-list
'("fixme" "FIXME" "Fixme" "fix me" "Fix me" "XXX")
"List of keywords for Sawfish used in highlighting.
Highlight these expressions with `font-lock-warning-face' even if
already fontified."
:group 'sawfish
:type '(repeat (string :tag "Keyword: ")))
;; Non customising variables.
(defvar sawfish-function-list nil
"List of sawfish functions.")
(defvar sawfish-variable-list nil
"List of sawfish variables.")
(defvar sawfish-function-p '(lambda (s)
(and
(boundp s)
(or
(functionp (symbol-value s))
(macrop (symbol-value s))
(special-form-p (symbol-value s)))))
"Closure to pass to sawfish-client for testing if a symbol is a function.")
(defvar sawfish-variable-p `(lambda (s)
(and (boundp s)
(not (,sawfish-function-p s))))
"Closure to pass to sawfish-client for testing if a symbol is a variable.")
(defvar sawfish-read-expression-map nil
"Minibuffer keymap used for reading sawfish lisp expressions.")
(defvar sawfish-interaction-mode-map nil
"Keymap for use with `sawfish-interaction'.")
(defvar sawfish-read-expression-history nil
"History list for `sawfish-eval-expression'.")
(defvar sawfish-describe-symbol
'(lambda (s)
(if (boundp s)
(cond ((special-form-p (symbol-value s)) "Special form")
((macrop (symbol-value s)) "Macro")
((subrp (symbol-value s)) "Built-in function")
((commandp (symbol-value s)) "Command")
((functionp (symbol-value s)) "Function")
((binding-immutable-p s ) "Constant")
(t "Variable"))
"Symbol"))
"Closure to pass to sawfish-client that will describe a symbol's binding.")
;; Constants.
(defconst sawfish-defines-regexp
(concat "(\\("
(regexp-opt
;; A cute way to obtain the list below would be:
;; (sawfish-code (mapcar symbol-name (apropos "^define")))
;;
;; It would, however, mean that you'd have a list of "keywords"
;; define in your running instance of sawfish. It would also
;; mean that you'd have to have sawfish running at the time
;; that this constant is defined.
(list
"define" "define-command-to-screen"
"define-custom-deserializer" "define-custom-serializer"
"define-custom-setter" "define-datum-printer"
"define-file-handler" "define-focus-mode"
"define-frame-class" "define-frame-type-mapper"
"define-interface" "define-linear-viewport-commands"
"define-match-window-formatter"
"define-match-window-group" "define-match-window-property"
"define-match-window-setter" "define-parse"
"define-placement-mode" "define-record-type"
"define-record-discloser" "define-scan-body"
"define-scan-form" "define-scan-internals"
"define-structure" "define-value"
"define-window-animator"))
"\\)\\>[ \t'(]*\\(\\sw+\\)?")
"List of define-structures known by Sawfish.")
(defconst sawfish-additional-keywords
(append lisp-font-lock-keywords-2
(list
;; highlight define-*
(list
sawfish-defines-regexp
'(1 font-lock-keyword-face)
`(,(regexp-opt-depth sawfish-defines-regexp)
font-lock-variable-name-face nil t))
;; extra keywords
(if sawfish-extra-keyword-list
(list (concat "\\<"
`,(regexp-opt sawfish-extra-keyword-list)
"\\>")
'(0 font-lock-keyword-face)))
;; highlight warnings
(if sawfish-warning-keyword-list
(list (concat "\\<"
`,(regexp-opt sawfish-warning-keyword-list)
"\\>")
'(0 font-lock-warning-face prepend)))))
"Some additional keywords to highlight in `sawfish-mode'.")
;; Main code:
;;;###autoload
(define-derived-mode sawfish-mode emacs-lisp-mode "Sawfish"
"Major mode for editing sawfish files and for interacting with sawfish.
Special commands:
\\{sawfish-mode-map}"
;; `define-derived-mode' in both GNU Emacs and XEmacs doesn't appear to
;; derive the font-lock settings. So, depending on the editor in use we
;; need to drag those settings down to us in different ways (hmm)....
(if (and (boundp 'running-xemacs) (symbol-value 'running-xemacs))
;; XEmacs appears to do something like this...
(put 'sawfish-mode 'font-lock-defaults
(get 'emacs-lisp-mode 'font-lock-defaults))
;; Add the additional font-lock pattern to `font-lock-defaults'
;; only once
(unless (memq 'sawfish-additional-keywords (car font-lock-defaults))
(setq font-lock-defaults (copy-alist font-lock-defaults))
(setcar font-lock-defaults
(append (car font-lock-defaults)
'(sawfish-additional-keywords)))))
;; Menu stuff.
(if (and (boundp 'running-xemacs) (symbol-value 'running-xemacs))
;; XEmacs.
(progn
;; For some odd reason `delete-menu-item' doesn't seem to always work.
;; Anyone know why?
(delete-menu-item '("Emacs-Lisp"))
;; XEmacs seems to require that you add the menu yourself.
(easy-menu-add sawfish-mode-menu))
;; See the end of this file for the code that removes the emacs lisp
;; menu.
)
;; Add support for #| ... |# style comments (call it style b) see GNU
;; Emacs Lisp Reference Manual (Rev. 2.5), p. 673-675
(modify-syntax-entry ?# "' 14b") ; quote or comment (style b)
(modify-syntax-entry ?| "_ 23b") ; symbol or comment (style b)
(modify-syntax-entry ?\n ">a") ; end comment (style a)
(make-local-variable 'lisp-indent-function)
(setq lisp-indent-function 'sawfish-indent-function)
(loop for sym in '((define . 1)
(define-interface . 1)
(define-record-discloser . 1)
(define-record-type . 1)
(define-structure . 3)
(let . 'scheme-let-indent)
(letrec . 1)
(let-fluids . 1)
(structure . 2)
(with-output-to-screen . 0))
do (unless (get (car sym) 'sawfish-indent-function)
(put (car sym) 'sawfish-indent-function (cdr sym)))))
;; Copied from scheme-indent-function which copied lisp-indent-function.
;; The only object is the support of scheme-let-indent.
(defun sawfish-indent-function (indent-point state)
(let ((normal-indent (current-column)))
(goto-char (1+ (elt state 1)))
(parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
(if (and (elt state 2)
(not (looking-at "\\sw\\|\\s_")))
;; car of form doesn't seem to be a symbol
(progn
(if (not (> (save-excursion (forward-line 1) (point))
calculate-lisp-indent-last-sexp))
(progn (goto-char calculate-lisp-indent-last-sexp)
(beginning-of-line)
(parse-partial-sexp (point)
calculate-lisp-indent-last-sexp 0 t)))
;; Indent under the list or under the first sexp on the same
;; line as calculate-lisp-indent-last-sexp. Note that first
;; thing on that line has to be complete sexp since we are
;; inside the innermost containing sexp.
(backward-prefix-chars)
(current-column))
(let ((function (buffer-substring (point)
(progn (forward-sexp 1) (point))))
method)
(setq method (or (get (intern-soft function) 'sawfish-indent-function)
(get (intern-soft function) 'lisp-indent-function)
(get (intern-soft function) 'lisp-indent-hook)))
(cond ((or (eq method 'defun)
(and (null method)
(> (length function) 3)
(string-match "\\`def" function)))
(lisp-indent-defform state indent-point))
((and (listp method)
(listp (cdr method))
(eq (cadr method) 'scheme-let-indent))
(funcall 'scheme-let-indent state indent-point normal-indent))
((integerp method)
(lisp-indent-specform method state
indent-point normal-indent))
(method
(funcall method indent-point state)))))))
(defun sawfish-eval (sexp &optional target-buffer)
"Pass SEXP to sawfish for evaluation.
SEXP can either be a list or a string.
If passed the result of the evaluation is inserted into TARGET-BUFFER."
(call-process sawfish-client nil target-buffer nil sawfish-exec-parameter
(if (stringp sexp) sexp (format "%S" sexp))))
;; It's better to `read' if possible. Otherwise the result printed
;; in the echo area is put in double-quotes.
(defun sawfish-string-readable-p (sexp)
"Can string SEXP be safely `read'?"
(condition-case nil
(progn
(read sexp)
t)
(error nil)))
(defun sawfish-buffer-readable-p (&optional buffer)
"Can the content of BUFFER be safely `read'?"
(sawfish-string-readable-p
(with-current-buffer (or buffer (current-buffer))
(buffer-string))))
(defun sawfish-eval-noread (sexp)
"Eval SEXP and return the result without `read'ing it."
(with-temp-buffer
(sawfish-eval sexp t)
(buffer-substring-no-properties (point-min) (1- (point-max)))))
(defun sawfish-eval-read (sexp)
"Eval SEXP and return the result of `read'ing the result.
SEXP can either be a list or a string."
(let ((result (sawfish-eval-noread sexp)))
(if (sawfish-string-readable-p result)
(read result)
result)))
(defun sawfish-pp (sexp &optional output)
"Pretty-prints SEXP to OUTPUT, using `read'. If it's impossible,
then returns nil.
It's not always possible, since evaluating a closure, for example,
returns the string #<closure foo @ sawfish.bar.baz> which can't be
`read'."
;; Simple replacement of #< doesn't work.
(condition-case nil
(progn
(pp (read sexp) output)
t ;; Success
)
(error ;; Failure
;; It may be due to #f and #t which are unreadable to emacs.
(condition-case nil
(progn
(setq sexp
(replace-regexp-in-string "#f" "__numberF" sexp))
(setq sexp
(replace-regexp-in-string "#t" "__numberT" sexp))
(setq sexp (pp-to-string (read sexp)))
(setq sexp
(replace-regexp-in-string "__numberT" "#t" sexp))
(setq sexp
(replace-regexp-in-string "__numberF" "#f" sexp))
(princ sexp (or output standard-output))
t
)
(error nil)))))
;;;###autoload
(defun sawfish-eval-region (start end &optional target-buffer)
"Evaluate the region bounded by START and END.
TARGET-BUFFER is the optional target for the return value of the
evaluation."
(interactive "r")
(sawfish-eval (buffer-substring-no-properties start end) target-buffer))
;;;###autoload
(defun sawfish-eval-buffer ()
"Evaluate the whole buffer."
(interactive)
(sawfish-eval-region (point-min) (point-max) nil))
;;;###autoload
(defun sawfish-eval-defun (insert-value)
"Evaluate the top level form at or near `point'.
INSERT-VALUE is a prefix parameter, if it is non-NIL the value of the
expression is inserted into the buffer after the form."
(interactive "P")
(save-restriction
(save-excursion
(narrow-to-defun)
(setf (point) (point-max))
(let ((result (sawfish-eval-last-sexp nil)))
(if insert-value
(let ((standard-output (current-buffer)))
(setf (point) (point-min))
(end-of-defun)
(unless (bolp)
(terpri))
(princ result)
(terpri))
(sawfish-output result))))))
;;;###autoload
(defun sawfish-eval-expression (sexp &optional insert-value)
"Evaluate SEXP and display the value in the minibuffer.
If the optional parameter INSERT-VALUE is supplied as a non-NIL value the
value of SEXP will be inserted into the current buffer."
(interactive
(list
(read-from-minibuffer "Sawfish Eval: " nil sawfish-read-expression-map t 'sawfish-read-expression-history)
current-prefix-arg))
(let ((result (sawfish-eval-noread sexp)))
(if insert-value
(let ((standard-output (current-buffer)))
(princ result))
(sawfish-output result))))
(defun sawfish-output (output)
"Display output either in mini-buffer or a separate buffer.
If the output is empty then the string \"No output\" is displayed.
If the output is one line long and the length of the line is less than the
`frame-width' then it is displayed using `message'.
If the output has multiple lines or is longer than `frame-width' then a new
buffer is opened and the text is displayed there. The name of the buffer is
set by the variable `sawfish-result-buffer'"
(with-temp-buffer
(let ((temp-buffer (current-buffer)))
(insert output)
(let ((lines (count-lines (point-min) (point-max))))
(cond
((zerop lines) ; Nothing to display.
(message "No output"))
((and (= 1 lines) ; If there is only one line
(< (- (point-max) ; and it isn't too wide for
(point-min)) ; the display.
(frame-width)))
(setf (point) (point-min))
(while (search-forward "\n" nil t)
(replace-match "" nil t)) ; Strip any trailing EOLs.
(when (get-buffer-window sawfish-result-buffer)
;; The long result buffer is visible, delete it.
(delete-window (get-buffer-window sawfish-result-buffer)))
(message "%s" (buffer-string)))
(t ; Too large for message area, use a buffer.
(with-output-to-temp-buffer sawfish-result-buffer
(with-current-buffer sawfish-result-buffer
(unless (sawfish-pp output (current-buffer))
(setf (buffer-string)
(format "%s" (with-current-buffer temp-buffer
(buffer-string)))))
(shrink-window-if-larger-than-buffer (display-buffer (current-buffer))))
(bury-buffer (current-buffer)))))))))
(defun sawfish-insert (string)
"Insert STRING into `current-buffer', pretty print if at all possible."
(unless (sawfish-pp string (current-buffer))
(insert string)))
;;;###autoload
(defun sawfish-eval-last-sexp (to-buffer)
"Version of `eval-last-sexp' that interacts with sawfish."
(interactive "P")
(let ((home-buffer (current-buffer)))
(with-temp-buffer
(let ((temp-buffer (current-buffer)))
(with-current-buffer home-buffer
(sawfish-eval-region (save-excursion
(backward-sexp)
(point))
(point)
temp-buffer)
(funcall (if to-buffer
'sawfish-insert
'sawfish-output)
(with-current-buffer temp-buffer (buffer-string))))))))
;;;###autoload
(defun sawfish-eval-print-last-sexp ()
(interactive)
(insert "\n")
(sawfish-eval-last-sexp t))
(defmacro sawfish-code (&rest body)
"Pass BODY to sawfish for evaluation.
For example, evaluate the following as elisp, and a new x terminal
starts.
(sawfish-code
(require 'sawfish.wm.commands.launcher)
(xterm))"
`(sawfish-eval-read (cons 'progn (quote ,body))))
(defun sawfish-load-helpers ()
"Load modules that help us work with sawfish."
(sawfish-code
(require 'rep.structures)
(require 'rep.lang.doc)))
(defun sawfish-load-symbols (&optional update)
"Loads the names of the sawfish functions and variables, and cache them.
When called interactively, re-reads them."
(interactive)
(unless (and (not (or update
(not sawfish-buffer-symbol-lists)
(called-interactively-p 'any)))
sawfish-function-list sawfish-variable-list)
(setq sawfish-function-list nil
sawfish-variable-list nil)
(flet ((sawfish-fun-p (sym) (second sym))
(sawfish-var-p (sym) (third sym)))
(loop for sym in (sawfish-eval-read
`(mapcar (lambda (sym)
(list
(symbol-name sym)
(or (macrop sym) (,sawfish-function-p sym))
(,sawfish-variable-p sym)))
(apropos ".")))
if (sawfish-fun-p sym) do (push (list (car sym)) sawfish-function-list)
if (sawfish-var-p sym) do (push (list (car sym)) sawfish-variable-list)))))
(defun sawfish-documentation (symbol &optional is-variable)
"Get the documentation for SYMBOL."
(if is-variable
(sawfish-eval-read `(documentation (quote ,symbol)))
(sawfish-eval-read `(documentation (quote ,symbol) nil ,symbol))))
(defun sawfish-funcall-at-point ()
"Try and work out the function being called at or near `point'."
;; `thing-at-point', when trying to grab a list, doesn't appear to do what
;; I need most of the time. I need to figure out what is wrong or write
;; something better.
;; Sometimes `read' fails, because of the syntax difference between
;; elisp and librep, so guard with condition-case.
(condition-case nil
(let ((list (thing-at-point 'list)))
(when list
(let ((fun (symbol-name (car (read list)))))
(when (assoc fun sawfish-function-list)
fun))))
(error nil)))
(defun sawfish-variable-at-point ()
"Try and work out the variable being called at or near `point'."
(let ((sym (thing-at-point 'symbol)))
(when sym
(let ((var (symbol-name (read sym))))
(when (assoc var sawfish-variable-list)
var)))))
(defun sawfish-describe-ask (default description lookups)
"Ask the user for a symbol.
The symbol will be described as DESCRIPTION with a completing read using
LOOKUPS for the completion. DEFAULT should be a function that returns a
default value for the read."
(sawfish-load-symbols)
(intern (completing-read (format "Sawfish %s: " description)
(symbol-value lookups)
nil
t
(funcall default))))
(defun sawfish-describe-ask-function ()
"Ask for a function name."
(sawfish-describe-ask 'sawfish-funcall-at-point "function" 'sawfish-function-list))
(defun sawfish-describe-ask-variable ()
"Ask for a variable name."
(sawfish-describe-ask 'sawfish-variable-at-point "variable" 'sawfish-variable-list))
(defun sawfish-info-function-index (info-file)
"Return the name of the function index from INFO-FILE.
This function is used to pull information from the entries found in the
variable `sawfish-info-files'."
(cadr info-file))
(defun sawfish-info-variable-index (info-file)
"Return the name of the variable index from INFO-FILE.
This function is used to pull information from the entries found in the
variable `sawfish-info-files'."
(car (cddr info-file)))
(defun sawfish-info-index-function (is-variable)
"Return the a function for accessing the info file list."
(if is-variable 'sawfish-info-variable-index 'sawfish-info-function-index))
(defun sawfish-describe-show (symbol &optional is-variable)
"Show the sawfish description for SYMBOL."
(with-output-to-temp-buffer sawfish-help-buffer
(princ (format "`%s' is a %s" symbol
(sawfish-eval-read `(,sawfish-describe-symbol (quote ,symbol)))))
(when is-variable
(princ "\n\nValue:\n\n")
(unless (sawfish-pp (sawfish-eval-noread symbol))
(princ (sawfish-eval-noread symbol))))
(princ "\n\nDocumentation:\n\n")
(let ((doc (or (sawfish-documentation symbol is-variable)
(sawfish-search-and-grab-info (sawfish-info-index-function is-variable) symbol))))
(if doc
(princ doc)
(princ (format "%s is undocumented" symbol))))
(let ((plist (sawfish-eval-read `(symbol-plist (quote ,symbol)))))
(when (and plist (listp plist))
(princ "\n\nProperty list for symbol:\n")
(loop for prop on plist by #'cddr
do (princ (format "\n%s: %S" (car prop) (cadr prop))))))))
;;;###autoload
(defun sawfish-describe-function (function)
"Display the doc-string for FUNCTION."
(interactive (list (sawfish-describe-ask-function)))
(sawfish-load-helpers)
(sawfish-describe-show function))
;;;###autoload
(defun sawfish-describe-variable (variable)
"Display the doc-string for VARIABLE."
(interactive (list (sawfish-describe-ask-variable)))
(sawfish-load-helpers)
(sawfish-describe-show variable t))
(defun sawfish-find-info-entry (info-file node symbol)
"Try to find SYMBOL in NODE of INFO-FILE.
If the symbol isn't found the Info buffer is killed and the function returns
nil, otherwise the Info buffer is left as the `current-buffer'."
(condition-case nil
(progn
(require 'info)
(Info-find-node info-file node)
(Info-menu (format "%s" symbol))
t)
(error
(when (string= (buffer-name) "*info*")
(kill-buffer (current-buffer)))
nil)))
(defun sawfish-jump-to-info-documentaiton (symbol)
"Jump to the documentation for SYMBOL in an info buffer.
Returns NIL if the documentation could not be found. Note that the
`current-buffer' must be the info buffer you are searching."
(prog1
(search-forward-regexp (format "^ - .*: %s" symbol) nil t)
(beginning-of-line)))
(defun sawfish-extract-info-entry (symbol)
"Extract the info documentation for SYMBOL as a string."
(when (sawfish-jump-to-info-documentaiton symbol)
;; For some odd reason, in XEmacs, the `current-buffer' inside
;; `with-output-to-string' is the string output buffer, not your
;; `current-buffer' before the call to `with-output-to-string'. Bizarre!
;; GNU emacs does the right thing.
;;
;; Anyway, to get round this odd behaviour you'll see lots of pointless
;; calls to `with-current-buffer' <sigh>.
(let ((info-buffer (current-buffer)))
(with-output-to-string nil
(princ (with-current-buffer info-buffer
(buffer-substring-no-properties
(+ (point) 3) ; Strip the leading " - ".
(save-excursion
(end-of-line)
(point)))))
(terpri)
(terpri)
(with-current-buffer info-buffer
(forward-line))
(loop while (with-current-buffer info-buffer
;; I'm not 100% sure what to look for when trying to
;; find the end of a info entry. This seems to work.
(and (not (eobp))
(or (looking-at "^ ")
(looking-at "^ *$"))))
do (let ((eol (with-current-buffer info-buffer
(save-excursion
(end-of-line)
(point)))))
(princ (with-current-buffer info-buffer
(buffer-substring-no-properties
(min (+ (point) 5) eol) ; Strip the leading white space.
eol))))
(terpri)
(with-current-buffer info-buffer
(forward-line)))))))
(defun sawfish-search-and-grab-info (index-function symbol)
"Look for SYMBOL in all the sawfish info files, return the docs.
INDEX-FUNCTION is used to decide which index name will be searched. The
function is used to access the lists in `sawfish-info-files'."
(save-excursion
(loop for info-file in sawfish-info-files
if (sawfish-find-info-entry (car info-file) (funcall index-function info-file) symbol)
return (prog1 (sawfish-extract-info-entry symbol) (kill-buffer (current-buffer)))
finally return nil)))
(defun sawfish-search-info-files (index-function symbol)
"Look for SYMBOL in all the sawfish info files.
INDEX-FUNCTION is used to decide which index name will be searched. The
function is used to access the lists in `sawfish-info-files'."
(loop for info-file in sawfish-info-files
if (sawfish-find-info-entry (car info-file) (funcall index-function info-file) symbol) return t
finally (error "No info documentation found for %s" symbol)))
(defun sawfish-search-info-files-for-function (function)
"Search for info documentation for FUNCTION."
(sawfish-search-info-files 'sawfish-info-function-index function))
(defun sawfish-search-info-files-for-variable (variable)
"Search for info documentation for VARIABLE."
(sawfish-search-info-files 'sawfish-info-variable-index variable))
;;;###autoload
(defun sawfish-info-function (function)
"Display the Info documentation for FUNCTION."
(interactive (list (sawfish-describe-ask-function)))
(sawfish-search-info-files-for-function function)
(sawfish-jump-to-info-documentaiton function))
;;;###autoload
(defun sawfish-info-variable (variable)
"Display the Info documentation for VARIABLE."
(interactive (list (sawfish-describe-ask-variable)))
(sawfish-search-info-files-for-variable variable)
(sawfish-jump-to-info-documentaiton variable))
(defsubst sawfish-apropos-symbol (sym)
"`sawfish-apropos' support function."
(nth 0 sym))
(defsubst sawfish-apropos-symbol-name (sym)
"`sawfish-apropos' support function."
(symbol-name (sawfish-apropos-symbol sym)))
(defsubst sawfish-apropos-description (sym)
"`sawfish-apropos' support function."
(nth 1 sym))
(defsubst sawfish-apropos-variable-p (sym)
"`sawfish-apropos' support function."
(nth 2 sym))
(defsubst sawfish-apropos-doc-string (sym)
"`sawfish-apropos' support function."
(nth 3 sym))
(defun sawfish-doc-string-first-line (doc-string)
"Given doc string DOC-STRING return the first line.
If the doc-string is NIL (no documentation) then \"Undocumented\" is
returned."
(if doc-string
(with-temp-buffer
(insert doc-string)
(setf (point) (point-min))
(end-of-line)
(buffer-substring-no-properties (point-min) (point)))
"Undocumented"))
(defun sawfish-remove-info-one-liner-intro (doc-string)
"Remove the leading symbol type text from an info derived doc-string."
(when doc-string
(with-temp-buffer
(insert doc-string)
(setf (point) (point-min))
(if (search-forward-regexp ": +" nil t)
(buffer-substring-no-properties (point) (point-max))
doc-string))))
(defun sawfish-apropos-insert-link (sym)
"Insert a documentation link for SYM into the apropos buffer."
(let ((start (point)))
(insert (sawfish-apropos-symbol-name sym))
(put-text-property start (point) 'face 'bold))
(insert "\n ")
(let ((start (point)))
(insert (sawfish-apropos-description sym) ":")
(put-text-property start (point) 'mouse-face 'highlight)
(let ((local-map (make-sparse-keymap))
(desc `(lambda ()
(interactive)
(,(if (sawfish-apropos-variable-p sym)
'sawfish-describe-variable 'sawfish-describe-function)
(quote ,(sawfish-apropos-symbol sym))))))
(define-key local-map [mouse-2] desc)
(define-key local-map [return] desc)
(put-text-property (- start 2) (point) 'local-map local-map)))
(insert " "
(sawfish-doc-string-first-line (or (sawfish-apropos-doc-string sym)
(and sawfish-apropos-searches-info-files
(sawfish-remove-info-one-liner-intro
(sawfish-search-and-grab-info
(sawfish-info-index-function
(sawfish-apropos-variable-p sym))
(sawfish-apropos-symbol sym))))))
"\n"))
;;;###autoload
(defun sawfish-apropos (regexp)
"Show all bound sawfish symbols whose names match REGEXP."
(interactive "sSawfish Apropos (regexp): ")
(sawfish-load-helpers)
(let ((hits (sort (sawfish-eval-read
`(progn
(require (quote lisp-doc))
(mapcar
(lambda (s)
(list s
(,sawfish-describe-symbol s)
(,sawfish-variable-p s)
(documentation s (,sawfish-variable-p s))))
(apropos ,regexp))))
(lambda (symX symY)
(string< (sawfish-apropos-symbol-name symX)
(sawfish-apropos-symbol-name symY))))))
(if (not (zerop (length hits)))
(with-output-to-temp-buffer sawfish-apropos-buffer
(with-current-buffer sawfish-apropos-buffer
(setf (buffer-string) "")
(loop for sym in hits do (sawfish-apropos-insert-link sym))))
(message "No apropos matches for `%s'" regexp))))
;;;###autoload
(defun sawfish-complete-symbol ()
"Attempt to complete the symbol at `point'."
(interactive)
(let ((sym (thing-at-point 'symbol)))
(when sym
(let* ((sym (symbol-name (read sym)))
(sym-re (concat "^" (regexp-quote sym)))
(completion (sawfish-eval-read
`(complete-string ,sym (mapcar symbol-name (apropos ,sym-re))))))
(if completion
(if (equal completion sym)
(let ((sym-list (sawfish-eval-read `(mapcar symbol-name (apropos ,(format "^%s" sym))))))
(when (> (length sym-list) 1)
(with-output-to-temp-buffer "*Completions*"
(display-completion-list
(sawfish-eval-read `(mapcar symbol-name (apropos ,sym-re)))))))
(let ((bounds (bounds-of-thing-at-point 'symbol)))
(delete-region (car bounds) (cdr bounds))
(insert completion)))
(error "No completion for `%s'" sym))))))
;;;###autoload
(defun sawfish-info ()
"View the sawfish info file."
(interactive)
(info "sawfish"))
;;;###autoload
(defun sawfish-rep-info ()
"View the librep info file."
(interactive)
(info "librep"))
(define-derived-mode sawfish-console-mode inferior-lisp-mode