forked from sebastiencs/company-box
-
Notifications
You must be signed in to change notification settings - Fork 0
/
company-box-doc.el
174 lines (148 loc) · 6.79 KB
/
company-box-doc.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
;;; company-box-doc.el --- Company front-end -*- lexical-binding: t -*-
;; Copyright (C) 2018 Sebastien Chapuis
;; Author: Sebastien Chapuis <sebastien@chapu.is>
;; URL: https://github.com/sebastiencs/company-box
;;; License
;;
;; 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, 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; see the file COPYING. If not, write to
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth
;; Floor, Boston, MA 02110-1301, USA.
;;; Commentary:
;;
;; Display candidate's documentation in another frame
;;; Code:
(require 'dash)
(require 'company)
(require 'frame-local)
(require 'cl-macs)
(require 'subr-x)
(defgroup company-box-doc nil
"Display documentation popups alongside company-box"
:group 'company)
(defcustom company-box-doc-enable t
"Enable company-box-doc by default."
:type 'boolean
:safe #'booleanp
:group 'company-box-doc)
(defcustom company-box-doc-delay 0.5
"The number of seconds to wait before displaying the popup."
:type 'number
:group 'company-box-doc)
(defvar company-box-doc-frame-parameters
'((internal-border-width . 10))
"Frame parameters to use on the doc frame.
`company-box-frame-parameters' is then append to this variable.")
(declare-function company-box--get-frame 'company-box)
(declare-function company-box--set-frame 'company-box)
(declare-function company-box--get-buffer 'company-box)
(declare-function company-box--make-frame 'company-box)
(defvar company-box-frame-parameters)
(defvar company-box--bottom)
(defvar company-box-scrollbar)
(defvar-local company-box-doc--timer nil)
(defun company-box-doc--fetch-doc-buffer (candidate)
(let ((inhibit-message t))
(--> (while-no-input
(-some-> (company-call-backend 'doc-buffer candidate)
(get-buffer)))
(if (eq t it) nil it))))
(defun company-box-doc--set-frame-position (frame)
(-let* ((box-position (frame-position (company-box--get-frame)))
(box-width (frame-pixel-width (company-box--get-frame)))
(window (frame-root-window frame))
(frame-resize-pixelwise t)
((width . height) (window-text-pixel-size window nil nil 10000 10000))
(bottom (+ company-box--bottom (window-pixel-top) (frame-border-width)))
(x (+ (car box-position) box-width (/ (frame-char-width) 2)))
(y (cdr box-position))
(y (if (> (+ y height 20) bottom)
(- y (- (+ y height) bottom) 20)
y))
(space-right (- (frame-pixel-width) x))
(space-left (car box-position))
(x (or (let ((border (* (or (alist-get 'internal-border-width company-box-doc-frame-parameters) 0)
2)))
(and (> width space-right)
(> space-left (+ width border (/ (frame-char-width) 2)))
(- (car box-position) width border (/ (frame-char-width) 2))))
x)))
(set-frame-position frame (max x 0) (max y 0))
(set-frame-size frame width height t)))
(defun company-box-doc--make-buffer (object)
(let* ((buffer-list-update-hook nil)
(inhibit-modification-hooks t)
(string (cond ((stringp object) object)
((bufferp object) (with-current-buffer object (buffer-string))))))
(when (and string (> (length (string-trim string)) 0))
(with-current-buffer (company-box--get-buffer "doc")
(erase-buffer)
(insert string)
(setq mode-line-format nil
display-line-numbers nil
header-line-format nil
show-trailing-whitespace nil
cursor-in-non-selected-windows nil)
(current-buffer)))))
(defun company-box-doc--make-frame (buffer)
(let* ((company-box-frame-parameters
(append company-box-doc-frame-parameters
company-box-frame-parameters))
(frame (company-box--make-frame buffer)))
;; (set-face-background 'internal-border "white" frame)
(set-frame-parameter frame 'name "")
frame))
(defun company-box-doc--show (selection frame)
(cl-letf (((symbol-function 'completing-read) #'company-box-completing-read)
(window-configuration-change-hook nil)
(inhibit-redisplay t)
(display-buffer-alist nil)
(buffer-list-update-hook nil))
(-when-let* ((valid-state (and (eq (selected-frame) frame)
company-box--bottom
company-selection
(company-box--get-frame)
(frame-visible-p (company-box--get-frame))))
(candidate (nth selection company-candidates))
(doc (or (company-call-backend 'quickhelp-string candidate)
(company-box-doc--fetch-doc-buffer candidate)))
(doc (company-box-doc--make-buffer doc)))
(unless (frame-live-p (frame-local-getq company-box-doc-frame))
(frame-local-setq company-box-doc-frame (company-box-doc--make-frame doc)))
(company-box-doc--set-frame-position (frame-local-getq company-box-doc-frame))
(unless (frame-visible-p (frame-local-getq company-box-doc-frame))
(make-frame-visible (frame-local-getq company-box-doc-frame))))))
(defun company-box-completing-read (_prompt candidates &rest _)
"`cider', and probably other libraries, prompt the user to
resolve ambiguous documentation requests. Instead of failing we
just grab the first candidate and press forward."
(car candidates))
(defun company-box-doc (selection frame)
(when company-box-doc-enable
(-some-> (frame-local-getq company-box-doc-frame frame)
(make-frame-invisible))
(when (timerp company-box-doc--timer)
(cancel-timer company-box-doc--timer))
(setq company-box-doc--timer
(run-with-timer
company-box-doc-delay nil
(lambda nil
(company-box-doc--show selection frame)
(company-ensure-emulation-alist))))))
(defun company-box-doc--hide (frame)
(-some-> (frame-local-getq company-box-doc-frame frame)
(make-frame-invisible)))
(defun company-box-doc-manually ()
(interactive)
(company-box-doc--show company-selection (or (frame-parent) (selected-frame))))
(define-key company-active-map [remap company-show-doc-buffer] 'company-box-doc-manually)
(provide 'company-box-doc)
;;; company-box-doc.el ends here