forked from auto-complete/popup-el
/
popup.el
1341 lines (1184 loc) · 49.3 KB
/
popup.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
;;; popup.el --- Visual Popup User Interface
;; Copyright (C) 2009, 2010, 2011, 2012 Tomohiro Matsuyama
;; Author: Tomohiro Matsuyama <tomo@cx4a.org>
;; Keywords: lisp
;; Version: 0.5
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; popup.el is a visual popup user interface library for Emacs. This
;; provides a basic API and common UI widgets such as popup tooltips
;; and popup menus.
;; See README.markdown for more information.
;;; Code:
(require 'cl)
;;; Utilities
(defvar popup-use-optimized-column-computation t
"Use the optimized column computation routine.
If there is a problem, please set it nil.")
(defmacro popup-aif (test then &rest else)
"Anaphoric if."
(declare (indent 2))
`(let ((it ,test))
(if it ,then ,@else)))
(defmacro popup-awhen (test &rest body)
"Anaphoric when."
(declare (indent 1))
`(let ((it ,test))
(when it ,@body)))
(defun popup-x-to-string (x)
"Convert any object to string effeciently.
This is faster than `prin1-to-string' in many cases."
(typecase x
(string x)
(symbol (symbol-name x))
(integer (number-to-string x))
(float (number-to-string x))
(t (format "%s" x))))
(defun popup-substring-by-width (string width)
"Return a cons cell of substring and remaining string by
splitting with WIDTH."
;; Expand tabs into 4 spaces
(setq string (replace-regexp-in-string "\t" " " string))
(loop with len = (length string)
with w = 0
for l from 0
for c in (append string nil)
while (<= (incf w (char-width c)) width)
finally return
(if (< l len)
(cons (substring string 0 l) (substring string l))
(list string))))
(defun popup-fill-string (string &optional width max-width justify squeeze)
"Split STRING into fixed width strings and return a cons cell
like \(WIDTH . ROWS). Here, the car WIDTH indicates the actual
maxim width of ROWS.
The argument WIDTH specifies the width of filling each
paragraph. WIDTH nil means don't perform any justification and
word wrap. Note that this function doesn't add any padding
characters at the end of each row.
MAX-WIDTH, if WIDTH is nil, specifies the maximum number of
columns.
The optional fourth argument JUSTIFY specifies which kind of
justification to do: `full', `left', `right', `center', or
`none' (equivalent to nil). A value of t means handle each
paragraph as specified by its text properties.
SQUEEZE nil means leave whitespaces other than line breaks
untouched."
(if (eq width 0)
(error "Can't fill string with 0 width"))
(if width
(setq max-width width))
(with-temp-buffer
(let ((tab-width 4)
(fill-column width)
(left-margin 0)
(kinsoku-limit 1)
indent-tabs-mode
row rows)
(insert string)
(untabify (point-min) (point-max))
(if width
(fill-region (point-min) (point-max) justify (not squeeze)))
(goto-char (point-min))
(setq width 0)
(while (prog2
(let ((line (buffer-substring
(point) (progn (end-of-line) (point)))))
(if max-width
(while (progn
(setq row (truncate-string-to-width line max-width)
width (max width (string-width row)))
(push row rows)
(if (not (= (length row) (length line)))
(setq line (substring line (length row))))))
(setq width (max width (string-width line)))
(push line rows)))
(< (point) (point-max))
(beginning-of-line 2)))
(cons width (nreverse rows)))))
(defmacro popup-save-buffer-state (&rest body)
(declare (indent 0))
`(save-excursion
(let ((buffer-undo-list t)
(inhibit-read-only t)
(modified (buffer-modified-p)))
(unwind-protect
(progn ,@body)
(set-buffer-modified-p modified)))))
(defun popup-preferred-width (list)
"Return the preferred width to show LIST beautifully."
(loop with tab-width = 4
for item in list
for summary = (popup-item-summary item)
maximize (string-width (popup-x-to-string item)) into width
if (stringp summary)
maximize (+ (string-width summary) 2) into summary-width
finally return
(let ((total (+ (or width 0) (or summary-width 0))))
(* (ceiling (/ total 10.0)) 10))))
(defun popup-window-full-width-p (&optional window)
"A portable version of `window-full-width-p'."
(if (fboundp 'window-full-width-p)
(window-full-width-p window)
(= (window-width window) (frame-width (window-frame (or window (selected-window)))))))
(defun popup-truncated-partial-width-window-p (&optional window)
"A portable version of `truncated-partial-width-window-p'."
(unless window
(setq window (selected-window)))
(unless (popup-window-full-width-p window)
(let ((t-p-w-w (buffer-local-value 'truncate-partial-width-windows
(window-buffer window))))
(if (integerp t-p-w-w)
(< (window-width window) t-p-w-w)
t-p-w-w))))
(defun popup-current-physical-column ()
"Return the current physical column."
(or (when (and popup-use-optimized-column-computation
(eq (window-hscroll) 0))
(let ((current-column (current-column)))
(if (or (popup-truncated-partial-width-window-p)
truncate-lines
(< current-column (window-width)))
current-column)))
(car (posn-col-row (posn-at-point)))))
(defun popup-vertical-motion (column direction)
"A portable version of `vertical-motion'."
(if (>= emacs-major-version 23)
(vertical-motion (cons column direction))
(vertical-motion direction)
(move-to-column (+ (current-column) column))))
(defun popup-last-line-of-buffer-p ()
"Return non-nil if the cursor is at the last line of the
buffer."
(save-excursion (end-of-line) (/= (forward-line) 0)))
(defun popup-lookup-key-by-event (function event)
(or (funcall function (vector event))
(if (symbolp event)
(popup-aif (get event 'event-symbol-element-mask)
(funcall function
(vector (logior (or (get (car it) 'ascii-character)
0)
(cadr it))))))))
;;; Core
(defgroup popup nil
"Visual Popup User Interface"
:group 'lisp
:prefix "popup-")
(defface popup-face
'((t (:background "lightgray" :foreground "black")))
"Face for popup."
:group 'popup)
(defface popup-summary-face
'((t (:inherit popup-face :foreground "dimgray")))
"Face for popup summary."
:group 'popup)
(defface popup-scroll-bar-foreground-face
'((t (:background "black")))
"Foreground face for scroll-bar."
:group 'popup)
(defface popup-scroll-bar-background-face
'((t (:background "gray")))
"Background face for scroll-bar."
:group 'popup)
(defvar popup-instances nil
"Popup instances.")
(defvar popup-scroll-bar-foreground-char
(propertize " " 'face 'popup-scroll-bar-foreground-face)
"Foreground character for scroll-bar.")
(defvar popup-scroll-bar-background-char
(propertize " " 'face 'popup-scroll-bar-background-face)
"Background character for scroll-bar.")
(defstruct popup
point row column width height min-height direction overlays keymap
parent depth
face mouse-face selection-face summary-face
margin-left margin-right margin-left-cancel scroll-bar symbol
cursor offset scroll-top current-height list newlines
pattern original-list)
(defun popup-item-propertize (item &rest properties)
"Same as `propertize' except that this avoids overriding
existed value with `nil' property."
(loop for (k v) on properties by 'cddr
if v append (list k v) into props
finally return
(apply 'propertize
(popup-x-to-string item)
props)))
(defun popup-item-property (item property)
"Same as `get-text-property' except that this returns nil if
ITEM is not string."
(if (stringp item)
(get-text-property 0 property item)))
(defun* popup-make-item (name
&key
value
face
mouse-face
selection-face
sublist
document
symbol
summary)
"Utility function to make popup item. See also
`popup-item-propertize'."
(popup-item-propertize name
'value value
'popup-face face
'popup-mouse-face mouse-face
'selection-face selection-face
'document document
'symbol symbol
'summary summary
'sublist sublist))
(defsubst popup-item-value (item) (popup-item-property item 'value))
(defsubst popup-item-value-or-self (item) (or (popup-item-value item) item))
(defsubst popup-item-face (item) (popup-item-property item 'popup-face))
(defsubst popup-item-mouse-face (item) (popup-item-property item 'popup-mouse-face))
(defsubst popup-item-selection-face (item) (popup-item-property item 'selection-face))
(defsubst popup-item-document (item) (popup-item-property item 'document))
(defsubst popup-item-summary (item) (popup-item-property item 'summary))
(defsubst popup-item-symbol (item) (popup-item-property item 'symbol))
(defsubst popup-item-sublist (item) (popup-item-property item 'sublist))
(defun popup-item-documentation (item)
(let ((doc (popup-item-document item)))
(if (functionp doc)
(setq doc (funcall doc (popup-item-value-or-self item))))
doc))
(defun popup-item-show-help-1 (item)
(let ((doc (popup-item-documentation item)))
(when doc
(with-current-buffer (get-buffer-create " *Popup Help*")
(erase-buffer)
(insert doc)
(goto-char (point-min))
(display-buffer (current-buffer)))
t)))
(defun popup-item-show-help-with-event-loop (item)
(save-window-excursion
(when (popup-item-show-help-1 item)
(loop do (clear-this-command-keys)
for key = (read-key-sequence-vector nil)
do
(case (key-binding key)
('scroll-other-window
(scroll-other-window))
('scroll-other-window-down
(scroll-other-window-down nil))
(t
(setq unread-command-events (append key unread-command-events))
(return)))))))
(defun popup-item-show-help (item &optional persist)
"Display the documentation of ITEM with `display-buffer'. If
PERSIST is nil, the documentation buffer will be closed
automatically, meaning interal event loop ensures the buffer to
be closed. Otherwise, the buffer will be just displayed as
usual."
(when item
(if (not persist)
(popup-item-show-help-with-event-loop item)
(popup-item-show-help-1 item))))
(defun popup-set-list (popup list)
(popup-set-filtered-list popup list)
(setf (popup-pattern popup) nil)
(setf (popup-original-list popup) list))
(defun popup-set-filtered-list (popup list)
(let ((offset
(if (> (popup-direction popup) 0)
0
(max (- (popup-height popup) (length list)) 0))))
(setf (popup-list popup) list
(popup-offset popup) offset)))
(defun popup-selected-item (popup)
(nth (popup-cursor popup) (popup-list popup)))
(defun popup-selected-line (popup)
(- (popup-cursor popup) (popup-scroll-top popup)))
(defun popup-line-overlay (popup line)
(aref (popup-overlays popup) line))
(defun popup-selected-line-overlay (popup)
(popup-line-overlay popup (popup-selected-line popup)))
(defun popup-hide-line (popup line)
(let ((overlay (popup-line-overlay popup line)))
(overlay-put overlay 'display nil)
(overlay-put overlay 'after-string nil)))
(defun popup-line-hidden-p (popup line)
(let ((overlay (popup-line-overlay popup line)))
(and (eq (overlay-get overlay 'display) nil)
(eq (overlay-get overlay 'after-string) nil))))
(defun* popup-set-line-item (popup
line
&key
item
face
mouse-face
margin-left
margin-right
scroll-bar-char
symbol
summary
summary-face
keymap)
(let* ((overlay (popup-line-overlay popup line))
(content (popup-create-line-string popup (popup-x-to-string item)
:margin-left margin-left
:margin-right margin-right
:symbol symbol
:summary summary
:summary-face summary-face))
(start 0)
(prefix (overlay-get overlay 'prefix))
(postfix (overlay-get overlay 'postfix))
end)
(put-text-property 0 (length content) 'popup-item item content)
(put-text-property 0 (length content) 'keymap keymap content)
;; Overlap face properties
(when (get-text-property start 'face content)
(setq start (next-single-property-change start 'face content)))
(while (and start (setq end (next-single-property-change start 'face content)))
(put-text-property start end 'face face content)
(setq start (next-single-property-change end 'face content)))
(when start
(put-text-property start (length content) 'face face content))
(when mouse-face
(put-text-property 0 (length content) 'mouse-face mouse-face content))
(unless (overlay-get overlay 'dangle)
(overlay-put overlay 'display (concat prefix (substring content 0 1)))
(setq prefix nil
content (concat (substring content 1))))
(overlay-put overlay
'after-string
(concat prefix
content
scroll-bar-char
postfix))))
(defun* popup-create-line-string (popup
string
&key
margin-left
margin-right
symbol
summary
summary-face)
(let* ((popup-width (popup-width popup))
(summary-width (string-width summary))
(content-width (max
(min popup-width (string-width string))
(- popup-width
(if (> summary-width 0)
(+ summary-width 2)
0))))
(string (car (popup-substring-by-width string content-width)))
(string-width (string-width string))
(spacing (max (- popup-width string-width summary-width)
(if (> popup-width string-width) 1 0)))
(truncated-summary
(car (popup-substring-by-width
summary (max (- popup-width string-width spacing) 0)))))
(when summary-face
(put-text-property 0 (length truncated-summary)
'face summary-face truncated-summary))
(concat margin-left
string
(make-string spacing ? )
truncated-summary
symbol
margin-right)))
(defun popup-live-p (popup)
"Return non-nil if POPUP is alive."
(and popup (popup-overlays popup) t))
(defun popup-child-point (popup &optional offset)
(overlay-end
(popup-line-overlay
popup
(or offset
(popup-selected-line popup)))))
(defun popup-calculate-direction (height row)
"Return a proper direction when displaying a popup on this
window. HEIGHT is the a height of the popup, and ROW is a line
number at the point."
(let* ((remaining-rows (- (max 1 (- (window-height)
(if mode-line-format 1 0)
(if header-line-format 1 0)))
(count-lines (window-start) (point))))
(enough-space-above (> row height))
(enough-space-below (<= height remaining-rows)))
(if (and enough-space-above
(not enough-space-below))
-1
1)))
(defun* popup-create (point
width
height
&key
min-height
around
(face 'popup-face)
mouse-face
(selection-face face)
(summary-face 'popup-summary-face)
scroll-bar
margin-left
margin-right
symbol
parent
parent-offset
keymap)
"Create a popup instance at POINT with WIDTH and HEIGHT.
MIN-HEIGHT is a minimal height of the popup. The default value is
0.
If AROUND is non-nil, the popup will be displayed around the
point but not at the point.
FACE is a background face of the popup. The default value is POPUP-FACE.
SELECTION-FACE is a foreground (selection) face of the popup The
default value is POPUP-FACE.
If SCROLL-BAR is non-nil, the popup will have a scroll bar at the
right.
If MARGIN-LEFT is non-nil, the popup will have a margin at the
left.
If MARGIN-RIGHT is non-nil, the popup will have a margin at the
right.
SYMBOL is a single character which indicates a kind of the item.
PARENT is a parent popup instance. If PARENT is omitted, the
popup will be a root instance.
PARENT-OFFSET is a row offset from the parent popup.
KEYMAP is a keymap that will be put on the popup contents."
(or margin-left (setq margin-left 0))
(or margin-right (setq margin-right 0))
(unless point
(setq point
(if parent (popup-child-point parent parent-offset) (point))))
(save-excursion
(goto-char point)
(let* ((row (line-number-at-pos))
(column (popup-current-physical-column))
(overlays (make-vector height nil))
(popup-width (+ width
(if scroll-bar 1 0)
margin-left
margin-right
(if symbol 2 0)))
margin-left-cancel
(window (selected-window))
(window-start (window-start))
(window-hscroll (window-hscroll))
(window-width (window-width))
(right (+ column popup-width))
(overflow (and (> right window-width)
(>= right popup-width)))
(foldable (and (null parent)
(>= column popup-width)))
(direction (or
;; Currently the direction of cascade popup won't be changed
(and parent (popup-direction parent))
;; Calculate direction
(popup-calculate-direction height row)))
(depth (if parent (1+ (popup-depth parent)) 0))
(newlines (max 0 (+ (- height (count-lines point (point-max))) (if around 1 0))))
current-column)
;; Case: no newlines at the end of the buffer
(when (> newlines 0)
(popup-save-buffer-state
(goto-char (point-max))
(insert (make-string newlines ?\n))))
;; Case: the popup overflows
(if overflow
(if foldable
(progn
(decf column (- popup-width margin-left margin-right))
(unless around (move-to-column column)))
(when (not truncate-lines)
;; Truncate.
(let ((d (1+ (- popup-width (- window-width column)))))
(decf popup-width d)
(decf width d)))
(decf column margin-left))
(decf column margin-left))
;; Case: no space at the left
(when (and (null parent)
(< column 0))
;; Cancel margin left
(setq column 0)
(decf popup-width margin-left)
(setq margin-left-cancel t))
(dotimes (i height)
(let (overlay begin w (dangle t) (prefix "") (postfix ""))
(when around
(popup-vertical-motion column direction))
(setq around t
current-column (popup-current-physical-column))
(when (> current-column column)
(backward-char)
(setq current-column (popup-current-physical-column)))
(when (< current-column column)
;; Extend short buffer lines by popup prefix (line of spaces)
(setq prefix (make-string
(+ (if (= current-column 0)
(- window-hscroll (current-column))
0)
(- column current-column))
? )))
(setq begin (point))
(setq w (+ popup-width (length prefix)))
(while (and (not (eolp)) (> w 0))
(setq dangle nil)
(decf w (char-width (char-after)))
(forward-char))
(if (< w 0)
(setq postfix (make-string (- w) ? )))
(setq overlay (make-overlay begin (point)))
(overlay-put overlay 'window window)
(overlay-put overlay 'dangle dangle)
(overlay-put overlay 'prefix prefix)
(overlay-put overlay 'postfix postfix)
(overlay-put overlay 'width width)
(aset overlays
(if (> direction 0) i (- height i 1))
overlay)))
(loop for p from (- 10000 (* depth 1000))
for overlay in (nreverse (append overlays nil))
do (overlay-put overlay 'priority p))
(let ((it (make-popup :point point
:row row
:column column
:width width
:height height
:min-height min-height
:direction direction
:parent parent
:depth depth
:face face
:mouse-face mouse-face
:selection-face selection-face
:summary-face summary-face
:margin-left margin-left
:margin-right margin-right
:margin-left-cancel margin-left-cancel
:scroll-bar scroll-bar
:symbol symbol
:cursor 0
:offset 0
:scroll-top 0
:current-height 0
:list nil
:newlines newlines
:overlays overlays
:keymap keymap)))
(push it popup-instances)
it))))
(defun popup-delete (popup)
"Delete POPUP instance."
(when (popup-live-p popup)
(popup-hide popup)
(mapc 'delete-overlay (popup-overlays popup))
(setf (popup-overlays popup) nil)
(setq popup-instances (delq popup popup-instances))
;; Restore newlines state
(let ((newlines (popup-newlines popup)))
(when (> newlines 0)
(popup-save-buffer-state
(goto-char (point-max))
(dotimes (i newlines)
(if (= (char-before) ?\n)
(delete-char -1)))))))
nil)
(defun popup-draw (popup)
"Draw POPUP."
(loop with height = (popup-height popup)
with min-height = (popup-min-height popup)
with popup-face = (popup-face popup)
with mouse-face = (popup-mouse-face popup)
with selection-face = (popup-selection-face popup)
with summary-face-0 = (popup-summary-face popup)
with list = (popup-list popup)
with length = (length list)
with thum-size = (max (/ (* height height) (max length 1)) 1)
with page-size = (/ (+ 0.0 (max length 1)) height)
with scroll-bar = (popup-scroll-bar popup)
with margin-left = (make-string (if (popup-margin-left-cancel popup) 0 (popup-margin-left popup)) ? )
with margin-right = (make-string (popup-margin-right popup) ? )
with symbol = (popup-symbol popup)
with cursor = (popup-cursor popup)
with scroll-top = (popup-scroll-top popup)
with offset = (popup-offset popup)
with keymap = (popup-keymap popup)
for o from offset
for i from scroll-top
while (< o height)
for item in (nthcdr scroll-top list)
for page-index = (* thum-size (/ o thum-size))
for face = (if (= i cursor)
(or (popup-item-selection-face item) selection-face)
(or (popup-item-face item) popup-face))
for summary-face = (unless (= i cursor) summary-face-0)
for empty-char = (propertize " " 'face face)
for scroll-bar-char = (if scroll-bar
(cond
((and (not (eq scroll-bar :always))
(<= page-size 1))
empty-char)
((and (> page-size 1)
(>= cursor (* page-index page-size))
(< cursor (* (+ page-index thum-size) page-size)))
popup-scroll-bar-foreground-char)
(t
popup-scroll-bar-background-char))
"")
for sym = (if symbol
(concat " " (or (popup-item-symbol item) " "))
"")
for summary = (or (popup-item-summary item) "")
do
;; Show line and set item to the line
(popup-set-line-item popup o
:item item
:face face
:mouse-face mouse-face
:margin-left margin-left
:margin-right margin-right
:scroll-bar-char scroll-bar-char
:symbol sym
:summary summary
:summary-face summary-face
:keymap keymap)
finally
;; Remember current height
(setf (popup-current-height popup) (- o offset))
;; Hide remaining lines
(let ((scroll-bar-char (if scroll-bar (propertize " " 'face popup-face) ""))
(symbol (if symbol " " "")))
(if (> (popup-direction popup) 0)
(progn
(when min-height
(while (< o min-height)
(popup-set-line-item popup o
:item ""
:face popup-face
:margin-left margin-left
:margin-right margin-right
:scroll-bar-char scroll-bar-char
:symbol symbol
:summary "")
(incf o)))
(while (< o height)
(popup-hide-line popup o)
(incf o)))
(loop with h = (if min-height (- height min-height) offset)
for o from 0 below offset
if (< o h)
do (popup-hide-line popup o)
if (>= o h)
do (popup-set-line-item popup o
:item ""
:face popup-face
:margin-left margin-left
:margin-right margin-right
:scroll-bar-char scroll-bar-char
:symbol symbol
:summary ""))))))
(defun popup-hide (popup)
"Hide POPUP."
(dotimes (i (popup-height popup))
(popup-hide-line popup i)))
(defun popup-hidden-p (popup)
"Return non-nil if POPUP is hidden."
(let ((hidden t))
(when (popup-live-p popup)
(dotimes (i (popup-height popup))
(unless (popup-line-hidden-p popup i)
(setq hidden nil))))
hidden))
(defun popup-select (popup i)
"Select the item at I of POPUP and draw."
(setq i (+ i (popup-offset popup)))
(when (and (<= 0 i) (< i (popup-height popup)))
(setf (popup-cursor popup) i)
(popup-draw popup)
t))
(defun popup-next (popup)
"Select the next item of POPUP and draw."
(let ((height (popup-height popup))
(cursor (1+ (popup-cursor popup)))
(scroll-top (popup-scroll-top popup))
(length (length (popup-list popup))))
(cond
((>= cursor length)
;; Back to first page
(setq cursor 0
scroll-top 0))
((= cursor (+ scroll-top height))
;; Go to next page
(setq scroll-top (min (1+ scroll-top) (max (- length height) 0)))))
(setf (popup-cursor popup) cursor
(popup-scroll-top popup) scroll-top)
(popup-draw popup)))
(defun popup-previous (popup)
"Select the previous item of POPUP and draw."
(let ((height (popup-height popup))
(cursor (1- (popup-cursor popup)))
(scroll-top (popup-scroll-top popup))
(length (length (popup-list popup))))
(cond
((< cursor 0)
;; Go to last page
(setq cursor (1- length)
scroll-top (max (- length height) 0)))
((= cursor (1- scroll-top))
;; Go to previous page
(decf scroll-top)))
(setf (popup-cursor popup) cursor
(popup-scroll-top popup) scroll-top)
(popup-draw popup)))
(defun popup-scroll-down (popup &optional n)
"Scroll down N of POPUP and draw."
(let ((scroll-top (min (+ (popup-scroll-top popup) (or n 1))
(- (length (popup-list popup)) (popup-height popup)))))
(setf (popup-cursor popup) scroll-top
(popup-scroll-top popup) scroll-top)
(popup-draw popup)))
(defun popup-scroll-up (popup &optional n)
"Scroll up N of POPUP and draw."
(let ((scroll-top (max (- (popup-scroll-top popup) (or n 1))
0)))
(setf (popup-cursor popup) scroll-top
(popup-scroll-top popup) scroll-top)
(popup-draw popup)))
;;; Popup Incremental Search
(defface popup-isearch-match
'((t (:background "sky blue")))
"Popup isearch match face."
:group 'popup)
(defvar popup-isearch-cursor-color "blue")
(defvar popup-isearch-keymap
(let ((map (make-sparse-keymap)))
;(define-key map "\r" 'popup-isearch-done)
(define-key map "\C-g" 'popup-isearch-cancel)
(define-key map "\C-h" 'popup-isearch-delete)
(define-key map (kbd "DEL") 'popup-isearch-delete)
map))
(defsubst popup-isearch-char-p (char)
(and (integerp char)
(<= 32 char)
(<= char 126)))
(defun popup-isearch-filter-list (pattern list)
(loop with regexp = (regexp-quote pattern)
for item in list
do
(unless (stringp item)
(setq item (popup-item-propertize (popup-x-to-string item)
'value item)))
if (string-match regexp item)
collect
(let ((beg (match-beginning 0))
(end (match-end 0)))
(alter-text-property 0 (length item) 'face
(lambda (prop)
(unless (eq prop 'popup-isearch-match)
prop))
item)
(put-text-property beg end
'face 'popup-isearch-match
item)
item)))
(defun popup-isearch-prompt (popup pattern)
(format "Pattern: %s" (if (= (length (popup-list popup)) 0)
(propertize pattern 'face 'isearch-fail)
pattern)))
(defun popup-isearch-update (popup pattern &optional callback)
(setf (popup-cursor popup) 0
(popup-scroll-top popup) 0
(popup-pattern popup) pattern)
(let ((list (popup-isearch-filter-list pattern (popup-original-list popup))))
(popup-set-filtered-list popup list)
(if callback
(funcall callback list)))
(popup-draw popup))
(defun* popup-isearch (popup
&key
(cursor-color popup-isearch-cursor-color)
(keymap popup-isearch-keymap)
callback
help-delay)
"Start isearch on POPUP. This function is synchronized, meaning
event loop waits for quiting of isearch.
CURSOR-COLOR is a cursor color during isearch. The default value
is `popup-isearch-cursor-color'.
KEYMAP is a keymap which is used when processing events during
event loop. The default value is `popup-isearch-keymap'.
CALLBACK is a function taking one argument. `popup-isearch' calls
CALLBACK, if specified, after isearch finished or isearch
canceled. The arguments is whole filtered list of items.
HELP-DELAY is a delay of displaying helps."
(let ((list (popup-original-list popup))
(pattern (or (popup-pattern popup) ""))
(old-cursor-color (frame-parameter (selected-frame) 'cursor-color))
prompt key binding)
(unwind-protect
(block nil
(if cursor-color
(set-cursor-color cursor-color))
(while t
(setq prompt (popup-isearch-prompt popup pattern))
(setq key (popup-menu-read-key-sequence keymap prompt help-delay))
(if (null key)
(unless (funcall popup-menu-show-quick-help-function popup nil :prompt prompt)
(clear-this-command-keys)
(push (read-event prompt) unread-command-events))
(setq binding (lookup-key keymap key))
(cond
((and (stringp key)
(popup-isearch-char-p (aref key 0)))
(setq pattern (concat pattern key)))
((eq binding 'popup-isearch-done)
(return nil))
((eq binding 'popup-isearch-cancel)
(popup-isearch-update popup "" callback)
(return t))
((eq binding 'popup-isearch-delete)
(if (> (length pattern) 0)
(setq pattern (substring pattern 0 (1- (length pattern))))))
(t
(setq unread-command-events
(append (listify-key-sequence key) unread-command-events))
(return nil)))
(popup-isearch-update popup pattern callback))))
(if old-cursor-color
(set-cursor-color old-cursor-color)))))
;;; Popup Tip
(defface popup-tip-face
'((t (:background "khaki1" :foreground "black")))
"Face for popup tip."
:group 'popup)
(defvar popup-tip-max-width 80)
(defun* popup-tip (string
&key
point
(around t)
width
(height 15)
min-height
truncate
margin
margin-left
margin-right
scroll-bar
parent
parent-offset
nowait
prompt
&aux tip lines)
"Show a tooltip of STRING at POINT. This function is
synchronized unless NOWAIT specified. Almost arguments are same
as `popup-create' except for TRUNCATE, NOWAIT, and PROMPT.
If TRUNCATE is non-nil, the tooltip can be truncated.
If NOWAIT is non-nil, this function immediately returns the
tooltip instance without entering event loop.