-
Notifications
You must be signed in to change notification settings - Fork 58
/
Copy pathposframe.el
1516 lines (1295 loc) · 58.2 KB
/
posframe.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
;;; posframe.el --- Pop a posframe (just a frame) at point -*- lexical-binding:t -*-
;; Copyright (C) 2018-2020 Free Software Foundation, Inc.
;; Author: Feng Shu <[email protected]>
;; Maintainer: Feng Shu <[email protected]>
;; URL: https://github.com/tumashu/posframe
;; Version: 1.4.4
;; Keywords: convenience, tooltip
;; Package-Requires: ((emacs "26.1"))
;; This file is not part of GNU Emacs.
;; GNU Emacs 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.
;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; * Posframe README :README:
;; Posframe can pop up a frame at point, this *posframe* is a
;; child-frame connected to its root window's buffer.
;; The main advantages are:
;; 1. It is fast enough for daily usage :-)
;; 2. It works well with CJK languages.
;; More info please see: README.org
;;; Code:
;; * posframe's code :CODE:
(require 'cl-lib)
(defgroup posframe nil
"Pop a posframe (just a frame) at point."
:group 'lisp
:prefix "posframe-")
(defcustom posframe-inhibit-double-buffering nil
"Set the posframe's frame-parameter: inhibit-double-buffering."
:group 'posframe
:type 'boolean)
(defcustom posframe-mouse-banish-function #'posframe-mouse-banish-default
"The function used to banish mouse.
Function `posframe-mouse-banish-default' will work well in most
case, but suggest use function `posframe-mouse-banish-simple' or
custom function for EXWM users."
:type 'function)
(defvar-local posframe--frame nil
"Record posframe's frame.")
(defvar-local posframe--last-posframe-pixel-position nil
"Record the last pixel position of posframe's frame.")
(defvar-local posframe--last-posframe-size nil
"Record the last size of posframe's frame.")
(defvar-local posframe--last-posframe-displayed-size nil
"Record the last displayed size of posframe's frame.")
(defvar-local posframe--last-parent-frame-size nil
"Record the last size of posframe's parent-frame.")
(defvar-local posframe--last-poshandler-info nil
"Record the last poshandler info.")
(defvar-local posframe--last-font-height-info nil
"Record the last font height info.")
(defvar-local posframe--last-args nil
"Record the last arguments of `posframe--create-posframe'.
If these args have changed, posframe will recreate its
frame.")
(defvar-local posframe--timeout-timer nil
"Record the timer to deal with timeout argument of `posframe-show'.")
(defvar-local posframe--refresh-timer nil
"Record the timer to deal with refresh argument of `posframe-show'.")
(defvar-local posframe--initialized-p nil
"Record initialize status of `posframe-show'.")
(defvar-local posframe--accept-focus nil
"Record accept focus status of `posframe-show'.")
(defvar posframe-hidehandler-timer nil
"Timer used by hidehandler function.")
;; Avoid compilation warnings on Emacs < 27.
(defvar x-gtk-resize-child-frames)
(defvar posframe-gtk-resize-child-frames
(when (and
(> emacs-major-version 26)
(string-match-p "GTK3" system-configuration-features)
(let ((value (or (getenv "XDG_CURRENT_DESKTOP") (getenv "DESKTOP_SESSION"))))
(and (stringp value)
;; It can be "ubuntu:GNOME".
(string-match-p "GNOME" value))))
;; Not future-proof, but we can use it now.
'resize-mode)
"Value to bind `x-gtk-resize-child-frames' to.
The value `resize-mode' only has effect on new child frames, so
if you change it, call `posframe-delete-all' for it to take
effect.")
;;;###autoload
(defun posframe-workable-p ()
"Test posframe workable status."
(and (>= emacs-major-version 26)
(not noninteractive)
(not emacs-basic-display)
(or (display-graphic-p)
(featurep 'tty-child-frames))
(eq (frame-parameter (selected-frame) 'minibuffer) 't)))
;;;###autoload
(cl-defun posframe-show (buffer-or-name
&key
string
position
poshandler
poshandler-extra-info
width
height
max-width
max-height
min-width
min-height
x-pixel-offset
y-pixel-offset
left-fringe
right-fringe
border-width
border-color
internal-border-width
internal-border-color
font
cursor
tty-non-selected-cursor
window-point
foreground-color
background-color
respect-header-line
respect-mode-line
initialize
no-properties
keep-ratio
lines-truncate
override-parameters
timeout
refresh
accept-focus
hidehandler
refposhandler
&allow-other-keys)
"Pop up a posframe to show STRING at POSITION.
(1) POSITION
POSITION can be:
1. An integer, meaning point position.
2. A cons of two integers, meaning absolute X and Y coordinates.
3. Other type, in which case the corresponding POSHANDLER should be
provided.
(2) POSHANDLER
POSHANDLER is a function of one argument returning an actual
position. Its argument is a plist of the following form:
(:position xxx
:poshandler xxx
:font-height xxx
:font-width xxx
:posframe xxx
:posframe-width xxx
:posframe-height xxx
:posframe-buffer xxx
:parent-frame xxx
:parent-window-start xxx
:parent-window-end xxx
:parent-window-left xxx
:parent-window-top xxx
:parent-frame-width xxx
:parent-frame-height xxx
:parent-window xxx
:parent-window-width xxx
:parent-window-height xxx
:mouse-x xxx
;mouse-y xxx
:minibuffer-height xxx
:mode-line-height xxx
:header-line-height xxx
:tab-line-height xxx
:x-pixel-offset xxx
:y-pixel-offset xxx)
By default, poshandler is auto-selected based on the type of POSITION,
but the selection can be overridden using the POSHANDLER argument.
The builtin poshandler functions are listed below:
1. `posframe-poshandler-frame-center'
2. `posframe-poshandler-frame-top-center'
3. `posframe-poshandler-frame-top-left-corner'
4. `posframe-poshandler-frame-top-right-corner'
5. `posframe-poshandler-frame-top-left-or-right-other-corner'
6. `posframe-poshandler-frame-bottom-center'
7. `posframe-poshandler-frame-bottom-left-corner'
8. `posframe-poshandler-frame-bottom-right-corner'
9. `posframe-poshandler-window-center'
10. `posframe-poshandler-window-top-center'
11. `posframe-poshandler-window-top-left-corner'
12. `posframe-poshandler-window-top-right-corner'
13. `posframe-poshandler-window-bottom-center'
14. `posframe-poshandler-window-bottom-left-corner'
15. `posframe-poshandler-window-bottom-right-corner'
16. `posframe-poshandler-point-top-left-corner'
17. `posframe-poshandler-point-bottom-left-corner'
18. `posframe-poshandler-point-bottom-left-corner-upward'
19. `posframe-poshandler-point-window-center'
20. `posframe-poshandler-point-frame-center'
(3) POSHANDLER-EXTRA-INFO
POSHANDLER-EXTRA-INFO is a plist, which will prepend to the
argument of poshandler function: `info', it will *OVERRIDE* the
exist key in `info'.
(4) BUFFER-OR-NAME
This posframe's buffer is BUFFER-OR-NAME, which can be a buffer
or a name of a (possibly nonexistent) buffer.
buffer name can prefix with space, for example \" *mybuffer*\", so
the buffer name will hide for ibuffer and `list-buffers'.
(5) NO-PROPERTIES
If NO-PROPERTIES is non-nil, The STRING's properties will
be removed before being shown in posframe.
(6) HEIGHT, MAX-HEIGHT, MIN-HEIGHT, WIDTH, MAX-WIDTH and MIN-WIDTH
These arguments are specified in the canonical character width
and height of posframe, more details can be found in docstring of
function `fit-frame-to-buffer',
(7) LEFT-FRINGE and RIGHT-FRINGE
If LEFT-FRINGE or RIGHT-FRINGE is a number, left fringe or
right fringe with be shown with the specified width.
(8) BORDER-WIDTH, BORDER-COLOR, INTERNAL-BORDER-WIDTH and INTERNAL-BORDER-COLOR
By default, posframe shows no borders, but users can specify
borders by setting BORDER-WIDTH to a positive number. Border
color can be specified by BORDER-COLOR.
INTERNAL-BORDER-WIDTH and INTERNAL-BORDER-COLOR are same as
BORDER-WIDTH and BORDER-COLOR, but do not suggest to use for the
reason:
Add distinct controls for child frames' borders (Bug#45620)
http://git.savannah.gnu.org/cgit/emacs.git/commit/?id=ff7b1a133bfa7f2614650f8551824ffaef13fadc
(9) FONT, FOREGROUND-COLOR and BACKGROUND-COLOR
Posframe's font as well as foreground and background colors are
derived from the current frame by default, but can be overridden
using the FONT, FOREGROUND-COLOR and BACKGROUND-COLOR arguments,
respectively.
(10) CURSOR, TTY-NON-SELECTED-CURSOR and WINDOW-POINT
By default, cursor is not showed in posframe, user can let cursor
showed with this argument help by set its value to a `cursor-type'.
TTY-NON-SELECTED-CURSOR will let redisplay put the terminal
cursor in a non-selected frame, which is useful when use
vertico-posframe like package in tty.
When cursor need to be showed in posframe, user may need to set
WINDOW-POINT to the point of BUFFER, which can let cursor showed
at this point.
(11) RESPECT-HEADER-LINE and RESPECT-MODE-LINE
By default, posframe will display no header-line, mode-line and
tab-line. In case a header-line, mode-line or tab-line is
desired, users can set RESPECT-HEADER-LINE and RESPECT-MODE-LINE
to t.
(12) INITIALIZE
INITIALIZE is a function with no argument. It will run when
posframe buffer is first selected with `with-current-buffer'
in `posframe-show', and only run once (for performance reasons).
(13) LINES-TRUNCATE
If LINES-TRUNCATE is non-nil, then lines will truncate in the
posframe instead of wrap.
(14) OVERRIDE-PARAMETERS
OVERRIDE-PARAMETERS is very powful, *all* the valid frame parameters
used by posframe's frame can be overridden by it.
NOTE: some `posframe-show' arguments are not frame parameters, so they
can not be overrided by this argument.
(15) TIMEOUT
TIMEOUT can specify the number of seconds after which the posframe
will auto-hide.
(15) REFRESH
If REFRESH is a number, posframe's frame-size will be re-adjusted
every REFRESH seconds.
(17) ACCEPT-FOCUS
When ACCEPT-FOCUS is non-nil, posframe will accept focus.
be careful, you may face some bugs when set it to non-nil.
(18) HIDEHANDLER
HIDEHANDLER is a function, when it return t, posframe will be
hide, this function has a plist argument:
(:posframe-buffer xxx
:posframe-parent-buffer xxx)
The builtin hidehandler functions are listed below:
1. `posframe-hidehandler-when-buffer-switch'
(19) REFPOSHANDLER
REFPOSHANDLER is a function, a reference position (most is
top-left of current frame) will be returned when call this
function.
when it is nil or it return nil, child-frame feature will be used
and reference position will be deal with in Emacs.
The user case I know at the moment is let ivy-posframe work well
in EXWM environment (let posframe show on the other application
window).
DO NOT USE UNLESS NECESSARY!!!
An example parent frame poshandler function is:
1. `posframe-refposhandler-xwininfo'
(19) Others
You can use `posframe-delete-all' to delete all posframes."
(let* ((position (or position (point)))
(max-width (if (numberp max-width)
(min max-width (frame-width))
(frame-width)))
(max-height (if (numberp max-height)
(min max-height (frame-height))
(frame-height)))
(min-width (min (or min-width 1) max-width))
(min-height (min (or min-height 1) max-height))
(width (when width
(min (max width min-width) max-width)))
(height (when height
(min (max height min-height) max-height)))
(x-pixel-offset (or x-pixel-offset 0))
(y-pixel-offset (or y-pixel-offset 0))
(window-point (or window-point 0))
;;-----------------------------------------------------
(buffer (get-buffer-create buffer-or-name))
(parent-window (selected-window))
(parent-window-start (window-start parent-window))
(parent-window-end (window-end parent-window))
(parent-window-top (window-pixel-top parent-window))
(parent-window-left (window-pixel-left parent-window))
(parent-window-width (window-pixel-width parent-window))
(parent-window-height (window-pixel-height parent-window))
(parent-frame (window-frame parent-window))
(parent-frame-width (frame-pixel-width parent-frame))
(parent-frame-height (frame-pixel-height parent-frame))
(ref-position
(when (functionp refposhandler)
(ignore-errors
(funcall refposhandler parent-frame))))
(font-width (default-font-width))
(font-height (with-current-buffer (window-buffer parent-window)
(posframe--get-font-height position)))
(mode-line-height (window-mode-line-height
(and (window-minibuffer-p)
(ignore-errors (window-in-direction 'above)))))
(minibuffer-height (window-pixel-height (minibuffer-window)))
(header-line-height (window-header-line-height parent-window))
(tab-line-height (if (functionp 'window-tab-line-height)
(window-tab-line-height)
0))
(mouse-position (cdr (mouse-pixel-position)))
(frame-resize-pixelwise t)
posframe)
(with-current-buffer buffer
;; Initialize
(unless posframe--initialized-p
(let ((func initialize))
(when (functionp func)
(funcall func)
(setq posframe--initialized-p t))))
;; Create posframe
(setq posframe
(posframe--create-posframe
buffer
:position position
:font font
:cursor cursor
:tty-non-selected-cursor tty-non-selected-cursor
:parent-frame
(unless ref-position
parent-frame)
:left-fringe left-fringe
:right-fringe right-fringe
:border-width border-width
:border-color border-color
:internal-border-width internal-border-width
:internal-border-color internal-border-color
:foreground-color foreground-color
:background-color background-color
:keep-ratio keep-ratio
:lines-truncate lines-truncate
:respect-header-line respect-header-line
:respect-mode-line respect-mode-line
:override-parameters override-parameters
:accept-focus accept-focus))
;; Insert string into the posframe buffer
(posframe--insert-string string no-properties)
(let ((size-info
(list :posframe posframe
:width width
:height height
:max-width max-width
:max-height max-height
:min-width min-width
:min-height min-height)))
;; Set posframe's size
(posframe--set-frame-size size-info)
;; Re-adjust posframe's size when buffer's content has changed.
(posframe--run-refresh-timer refresh size-info))
;; Get new position of posframe.
(setq position
(posframe-run-poshandler
;; All poshandlers will get info from this plist.
`(,@poshandler-extra-info
,@(list :position position
:poshandler poshandler
:font-height font-height
:font-width font-width
:posframe posframe
:posframe-width (frame-pixel-width posframe)
:posframe-height (frame-pixel-height posframe)
:posframe-buffer buffer
:parent-frame parent-frame
:parent-frame-width parent-frame-width
:parent-frame-height parent-frame-height
:ref-position ref-position
:parent-window parent-window
:parent-window-start parent-window-start
:parent-window-end parent-window-end
:parent-window-top parent-window-top
:parent-window-left parent-window-left
:parent-window-width parent-window-width
:parent-window-height parent-window-height
:mouse-x (car mouse-position)
:mouse-y (cdr mouse-position)
:mode-line-height mode-line-height
:minibuffer-height minibuffer-height
:header-line-height header-line-height
:tab-line-height tab-line-height
:x-pixel-offset x-pixel-offset
:y-pixel-offset y-pixel-offset))))
;; Move posframe
(posframe--set-frame-position
posframe position parent-frame-width parent-frame-height)
;; Delay hide posframe when timeout is a number.
(posframe--run-timeout-timer posframe timeout)
;; Make sure not hide buffer's content for scroll down.
(let ((window (frame-root-window posframe--frame)))
(when (window-live-p window)
(set-window-point window window-point)))
;; Hide posframe when switch buffer
(let* ((parent-buffer (window-buffer parent-window))
(parent-buffer-name (buffer-name parent-buffer)))
(set-frame-parameter posframe--frame 'posframe-hidehandler hidehandler)
(set-frame-parameter posframe--frame 'posframe-parent-buffer
(cons parent-buffer-name parent-buffer)))
;; Mouse banish
(funcall
posframe-mouse-banish-function
(list :parent-frame parent-frame
:mouse-x (when (car mouse-position)
(+ (or (car ref-position) 0)
(car mouse-position)))
:mouse-y (when (cdr mouse-position)
(+ (or (cdr ref-position) 0)
(cdr mouse-position)))
:posframe-x
(if (>= (car position) 0)
(car position)
(- (frame-pixel-width parent-frame)
(frame-pixel-width posframe)))
:posframe-y
(if (>= (cdr position) 0)
(cdr position)
(- (frame-pixel-height parent-frame)
(frame-pixel-height posframe)))
:posframe-width (frame-pixel-width posframe)
:posframe-height (frame-pixel-height posframe)
:parent-frame-width parent-frame-width
:parent-frame-height parent-frame-height))
;; Return posframe
posframe)))
(defun posframe--get-font-height (position)
"Get the font's height at POSITION."
(if (eq position (car posframe--last-font-height-info))
(cdr posframe--last-font-height-info)
(let* ((font (when (and (integerp position)
(not (= position 1)))
(font-at (if (>= position (point-max))
(- (point-max) 1)
position))))
(height (when (integerp position)
(if (or (= position 1) (not (fontp font)))
(default-line-height)
(aref (font-info font) 3)))))
(setq posframe--last-font-height-info
(cons position height))
height)))
(cl-defun posframe--create-posframe (buffer-or-name
&key
position
parent-frame
foreground-color
background-color
left-fringe
right-fringe
border-width
border-color
internal-border-width
internal-border-color
font
cursor
tty-non-selected-cursor
keep-ratio
lines-truncate
override-parameters
respect-header-line
respect-mode-line
accept-focus)
"Create and return a posframe child frame.
This posframe's buffer is BUFFER-OR-NAME.
The below optional arguments are similar to `posframe-show''s:
PARENT-FRAME, FOREGROUND-COLOR, BACKGROUND-COLOR, LEFT-FRINGE,
RIGHT-FRINGE, BORDER-WIDTH, BORDER-COLOR, INTERNAL-BORDER-WIDTH,
INTERNAL-BORDER-COLOR, FONT, KEEP-RATIO, LINES-TRUNCATE,
OVERRIDE-PARAMETERS, RESPECT-HEADER-LINE, RESPECT-MODE-LINE,
ACCEPT-FOCUS."
(let ((left-fringe (or left-fringe 0))
(right-fringe (or right-fringe 0))
;; See emacs.git: Add distinct controls for child frames' borders (Bug#45620)
;; http://git.savannah.gnu.org/cgit/emacs.git/commit/?id=ff7b1a133bfa7f2614650f8551824ffaef13fadc
(border-width (or border-width internal-border-width 0))
(border-color (or border-color internal-border-color))
(buffer (get-buffer-create buffer-or-name))
(after-make-frame-functions nil)
(x-gtk-resize-child-frames posframe-gtk-resize-child-frames)
(args (list "args"
(display-graphic-p)
foreground-color
background-color
right-fringe
left-fringe
border-width
border-color
internal-border-width
internal-border-color
font
keep-ratio
override-parameters
respect-header-line
respect-mode-line
accept-focus)))
(with-current-buffer buffer
;; Many variables take effect after call `set-window-buffer'
(setq-local display-line-numbers nil)
(setq-local frame-title-format "")
(setq-local left-margin-width nil)
(setq-local right-margin-width nil)
(setq-local left-fringe-width nil)
(setq-local right-fringe-width nil)
(setq-local fringes-outside-margins 0)
(setq-local fringe-indicator-alist nil)
;; Need to use `lines-truncate' as our keyword variable instead
;; of `truncate-lines' so we don't shadow the variable that we
;; are trying to set.
(setq-local truncate-lines lines-truncate)
(setq-local show-trailing-whitespace nil)
(setq-local posframe--accept-focus accept-focus)
(unless respect-mode-line
(setq-local mode-line-format nil))
(unless respect-header-line
(setq-local header-line-format nil))
(if cursor
(progn
(setq-local cursor-type cursor)
(setq-local cursor-in-non-selected-windows cursor))
(setq-local cursor-type nil)
(setq-local cursor-in-non-selected-windows nil))
;; Find existing posframe: buffer-local variables used by
;; posframe can be cleaned by other packages, so we should find
;; existing posframe first if possible.
(unless (or posframe--frame posframe--last-args)
(setq-local posframe--frame
(posframe--find-existing-posframe buffer args))
(setq-local posframe--last-args args))
;; Create child-frame
(unless (and posframe--frame
(frame-live-p posframe--frame)
;; For speed reason, posframe will reuse
;; existing frame at possible, but when
;; user change args, recreating frame
;; is needed.
(equal posframe--last-args args))
(posframe-delete-frame buffer)
(setq-local posframe--last-args args)
(setq-local posframe--last-posframe-pixel-position nil)
(setq-local posframe--last-posframe-size nil)
(setq-local posframe--frame
(make-frame
`(,@override-parameters
,(when foreground-color
(cons 'foreground-color foreground-color))
,(when background-color
(cons 'background-color background-color))
(title . "posframe")
(parent-frame . ,parent-frame)
(keep-ratio ,keep-ratio)
(posframe-buffer . ,(cons (buffer-name buffer)
buffer))
(fullscreen . nil)
(no-accept-focus . ,(not accept-focus))
(min-width . 0)
(min-height . 0)
(border-width . 0)
(internal-border-width . ,border-width)
(child-frame-border-width . ,border-width)
(vertical-scroll-bars . nil)
(horizontal-scroll-bars . nil)
(left-fringe . ,left-fringe)
(right-fringe . ,right-fringe)
(menu-bar-lines . 0)
(tool-bar-lines . 0)
(tab-bar-lines . 0)
(line-spacing . 0)
(unsplittable . t)
(no-other-frame . t)
;; NOTE: TTY child frame use undecorated to control border.
(undecorated . ,(or (display-graphic-p)
(not (and (> border-width 0)
(featurep 'tty-child-frames)))))
(visibility . nil)
(cursor-type . nil)
(tty-non-selected-cursor . ,tty-non-selected-cursor)
(minibuffer . ,(minibuffer-window parent-frame))
(left . ,(if (consp position) (car position) 0))
(top . ,(if (consp position) (cdr position) 0))
(width . 1)
(height . 1)
(no-special-glyphs . t)
(skip-taskbar . t)
(inhibit-double-buffering . ,posframe-inhibit-double-buffering)
;; Do not save child-frame when use desktop.el
(desktop-dont-save . t))))
(set-frame-parameter posframe--frame 'last-args args)
(set-frame-parameter
posframe--frame 'font
(or font (face-attribute 'default :font parent-frame)))
(when border-color
(if parent-frame
(set-face-background
(if (facep 'child-frame-border)
'child-frame-border
'internal-border)
border-color posframe--frame)
;; NOTE: when use refposhander feature, parent-frame will be
;; nil, we should use internal-border instead.
(set-face-background
'internal-border
border-color posframe--frame))
;; HACK: Set face background after border color, otherwise the
;; border is not updated (BUG!).
(when (version< emacs-version "28.0")
(set-frame-parameter
posframe--frame 'background-color
(or background-color (face-attribute 'default :background)))))
(let ((posframe-window (frame-root-window posframe--frame)))
;; This method is more stable than 'setq mode/header-line-format nil'
(unless respect-mode-line
(set-window-parameter posframe-window 'mode-line-format 'none))
(unless respect-header-line
(set-window-parameter posframe-window 'header-line-format 'none))
(set-window-buffer posframe-window buffer)
;; When the buffer of posframe is killed, the child-frame of
;; this posframe will be deleted too.
(set-window-dedicated-p posframe-window t)))
;; Remove tab-bar always.
;; NOTE: if we do not test the value of frame parameter
;; 'tab-bar-lines before set it, posframe will flicker when
;; scroll.
(unless (equal (frame-parameter posframe--frame 'tab-bar-lines) 0)
(set-frame-parameter posframe--frame 'tab-bar-lines 0))
(when (version< "27.0" emacs-version)
(setq-local tab-line-format nil))
;; If user set 'parent-frame to nil after run posframe-show.
;; for cache reason, next call to posframe-show will be affected.
;; so we should force set parent-frame again in this place.
(set-frame-parameter posframe--frame 'parent-frame parent-frame)
posframe--frame)))
(defun posframe--find-existing-posframe (buffer &optional last-args)
"Find existing posframe with BUFFER and LAST-ARGS."
(let ((posframe
(cl-find-if
(lambda (frame)
(let* ((buffer-info (frame-parameter frame 'posframe-buffer))
(buffer-equal-p
(or (equal (buffer-name buffer) (car buffer-info))
(equal buffer (cdr buffer-info)))))
(if last-args
(and buffer-equal-p
(equal last-args (frame-parameter frame 'last-args)))
buffer-equal-p)))
(frame-list))))
(when posframe
(set-frame-parameter posframe 'existing-posframe t))
posframe))
(defun posframe-delete-frame (buffer-or-name)
"Delete posframe pertaining to BUFFER-OR-NAME.
BUFFER-OR-NAME can be a buffer or a buffer name."
(let* ((buffer (get-buffer buffer-or-name))
(posframe (when buffer
(posframe--find-existing-posframe buffer)))
;; NOTE: `delete-frame' runs ‘delete-frame-functions’ before
;; actually deleting the frame, unless the frame is a
;; tooltip, posframe is a child-frame, but its function like
;; a tooltip.
(delete-frame-functions nil))
(when posframe
(when (buffer-live-p buffer)
(with-current-buffer buffer
(dolist (timer '(posframe--refresh-timer
posframe--timeout-timer))
(when (timerp timer)
(cancel-timer timer)))))
(delete-frame posframe))))
(defun posframe--insert-string (string no-properties)
"Insert STRING to current buffer.
If NO-PROPERTIES is non-nil, all properties of STRING
will be removed."
(when (and string (stringp string))
(remove-text-properties
0 (length string) '(read-only t) string)
(let ((str (if no-properties
(substring-no-properties string)
string)))
(erase-buffer)
(insert str))))
(defun posframe--set-frame-size (size-info)
"Set POSFRAME's size based on SIZE-INFO."
(let ((posframe (plist-get size-info :posframe))
(width (plist-get size-info :width))
(height (plist-get size-info :height))
(max-width (plist-get size-info :max-width))
(max-height (plist-get size-info :max-height))
(min-width (plist-get size-info :min-width))
(min-height (plist-get size-info :min-height)))
(when height (set-frame-height posframe height))
(when width (set-frame-width posframe width))
(unless (and height width)
(posframe--fit-frame-to-buffer
posframe max-height min-height max-width min-width
(cond (width 'vertically)
(height 'horizontally))))
(setq-local posframe--last-posframe-size size-info)))
(defun posframe--fit-frame-to-buffer (posframe max-height min-height max-width min-width only)
"POSFRAME version of function `fit-frame-to-buffer'.
Arguments HEIGHT, MAX-HEIGHT, MIN-HEIGHT, WIDTH, MAX-WIDTH,
MIN-WIDTH and ONLY are similar function `fit-frame-to-buffer''s."
;; This only has effect if the user set the latter var to `hide'.
(let ((x-gtk-resize-child-frames posframe-gtk-resize-child-frames))
;; More info: Don't skip empty lines when fitting mini frame to buffer (Bug#44080)
;; http://git.savannah.gnu.org/cgit/emacs.git/commit/?id=e0de9f3295b4c46cb7198ec0b9634809d7b7a36d
(if (functionp 'fit-frame-to-buffer-1)
(fit-frame-to-buffer-1
posframe max-height min-height max-width min-width only nil nil)
(fit-frame-to-buffer
posframe max-height min-height max-width min-width only))))
(defun posframe--run-refresh-timer (repeat size-info)
"Refresh POSFRAME every REPEAT seconds.
It will set POSFRAME's size by SIZE-INFO."
(let ((posframe (plist-get size-info :posframe))
(width (plist-get size-info :width))
(height (plist-get size-info :height)))
(when (and (numberp repeat) (> repeat 0))
(unless (and width height)
(when (timerp posframe--refresh-timer)
(cancel-timer posframe--refresh-timer))
(setq-local posframe--refresh-timer
(run-with-timer
nil repeat
(lambda (size-info)
(let ((frame-resize-pixelwise t))
(when (and posframe (frame-live-p posframe))
(posframe--set-frame-size size-info))))
size-info))))))
;; Posframe's position handler
(defun posframe-run-poshandler (info)
"Run posframe's position handler.
the structure of INFO can be found in docstring
of `posframe-show'."
(if (equal info posframe--last-poshandler-info)
posframe--last-posframe-pixel-position
(setq posframe--last-poshandler-info info)
(let* ((ref-position (plist-get info :ref-position))
(poshandler (posframe--get-valid-poshandler info))
(position (funcall poshandler info)))
(if (not ref-position)
position
(posframe--calculate-new-position
info position ref-position)))))
(defun posframe--get-valid-poshandler (info)
"Get valid poshandler function with the help of INFO."
(or (plist-get info :poshandler)
(let ((position (plist-get info :position)))
(cond ((integerp position)
#'posframe-poshandler-point-bottom-left-corner)
((and (consp position)
(integerp (car position))
(integerp (cdr position)))
#'posframe-poshandler-absolute-x-y)
(t (error "Posframe: have no valid poshandler"))))))
(defun posframe--calculate-new-position (info position ref-position)
"Calculate new position according to INFO, POSITION and REF-POSITION."
(let* ((parent-frame-width (plist-get info :parent-frame-width))
(parent-frame-height (plist-get info :parent-frame-height))
(posframe-width (plist-get info :posframe-width))
(posframe-height (plist-get info :posframe-height))
(ref-x (or (car ref-position) 0))
(ref-y (or (cdr ref-position) 0))
(x (car position))
(y (cdr position)))
(when (< x 0)
(setq x (- (+ x parent-frame-width) posframe-width)))
(when (< y 0)
(setq y (- (+ y parent-frame-height) posframe-height)))
(cons (+ ref-x x)
(+ ref-y y))))
(defun posframe--set-frame-position (posframe position
parent-frame-width
parent-frame-height)
"Move POSFRAME to POSITION.
This need PARENT-FRAME-WIDTH and PARENT-FRAME-HEIGHT"
(unless (and (equal position posframe--last-posframe-pixel-position)
;; When working frame's size change, re-posit
;; the posframe.
(equal posframe--last-parent-frame-size
(cons parent-frame-width parent-frame-height))
(equal posframe--last-posframe-displayed-size
(cons (frame-pixel-width posframe)
(frame-pixel-height posframe))))
(set-frame-position posframe (car position) (cdr position))
(setq-local posframe--last-posframe-pixel-position position)
(setq-local posframe--last-parent-frame-size
(cons parent-frame-width parent-frame-height))
(setq-local posframe--last-posframe-displayed-size
(cons (frame-pixel-width posframe)
(frame-pixel-height posframe))))
(posframe--make-frame-visible posframe))
(defun posframe--make-frame-visible (posframe)
"Let POSFRAME visible and redraw it when needed."
(unless (frame-visible-p posframe)
(make-frame-visible posframe)
(when (posframe--posframe-need-redraw-p posframe)
(redraw-frame posframe))))
(defun posframe--posframe-need-redraw-p (posframe)
"Test POSFRAME need to redraw or not."
;; When posframe is found by `posframe--find-existing-posframe',
;; it need to redraw, more info:
;; 1. https://github.com/tumashu/ivy-posframe/pull/30
;; 2. https://github.com/tumashu/posframe/pull/118
(frame-parameter posframe 'existing-posframe))
(defun posframe--run-timeout-timer (posframe secs)
"Hide POSFRAME after a delay of SECS seconds."
(when (and (numberp secs) (> secs 0))
(when (timerp posframe--timeout-timer)
(cancel-timer posframe--timeout-timer))
(setq-local posframe--timeout-timer
(run-with-timer
secs nil #'posframe--make-frame-invisible posframe))))
(defun posframe--make-frame-invisible (frame)
"`make-frame-invisible' replacement to hide FRAME safely."
(when (and (frame-live-p frame)
(frame-visible-p frame))
(make-frame-invisible frame)))
(defun posframe-mouse-banish-simple (info)
"Banish mouse to (0, 0) of posframe base on INFO."
(let ((parent-frame (plist-get info :parent-frame))
(x (plist-get info :posframe-x))
(y (plist-get info :posframe-y))
(w (plist-get info :posframe-width))
(h (plist-get info :posframe-height))
(p-w (plist-get info :parent-frame-width))
(p-h (plist-get info :parent-frame-height)))
(set-mouse-pixel-position
parent-frame
(if (= x 0)
(min p-w (+ w 5))
(max 0 (- x 5)))
(if (= y 0)
(min p-h (+ h 10))
(max 0 (- y 10))))))
(defun posframe-mouse-banish-default (info)
"Banish mouse base on INFO.
FIXME: This is a hacky fix for the mouse focus problem, which like:
https://github.com/tumashu/posframe/issues/4#issuecomment-357514918"
(let* ((parent-frame (plist-get info :parent-frame))
(m-x (plist-get info :mouse-x))
(m-y (plist-get info :mouse-y))
(x (plist-get info :posframe-x))
(y (plist-get info :posframe-y))
(w (plist-get info :posframe-width))