[elpa] externals/vertico-posframe d14e6c9 02/10: Init vertico-posframe.el

[ELPA Syncer]

branch: externals/vertico-posframe
commit d14e6c93665a41921ef37f29dffde251b352a7ca
Author: Feng Shu <tumashu@163.com>
Commit: Feng Shu <tumashu@163.com>

    Init vertico-posframe.el
---
 README.md           |   1 -
 README.org          |  26 ++++++
 vertico-posframe.el | 234 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 260 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
deleted file mode 100644
index ece581a..0000000
--- a/README.md
+++ /dev/null
@@ -1 +0,0 @@
-# vertico-posframe
\ No newline at end of file
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..ce0004f
--- /dev/null
+++ b/README.org
@@ -0,0 +1,26 @@
+#+TITLE: README of vertico-posframe
+
+** What is vertico-posframe
+
+vertico-posframe is an vertico extension, which lets vertico use
+posframe to show its candidate menu.
+
+NOTE: vertico-posframe requires Emacs 26 and do not support mouse
+click.
+
+** How to enable vertico-posframe
+#+BEGIN_EXAMPLE
+(require 'vertico-posframe)
+(vertico-posframe-mode 1)
+#+END_EXAMPLE
+
+** Tips
+*** How to show fringe to vertico-posframe
+#+BEGIN_EXAMPLE
+(setq vertico-posframe-parameters
+      '((left-fringe . 8)
+        (right-fringe . 8)))
+#+END_EXAMPLE
+
+By the way, User can set *any* parameters of vertico-posframe with
+the help of `vertico-posframe-parameters'.
diff --git a/vertico-posframe.el b/vertico-posframe.el
new file mode 100644
index 0000000..e5f4c29
--- /dev/null
+++ b/vertico-posframe.el
@@ -0,0 +1,234 @@
+;;; vertico-posframe.el --- Using posframe to show Vertico  -*- 
lexical-binding: t -*-
+
+;; Copyright (C) 2021 Free Software Foundation, Inc.
+
+;; Author: Feng Shu <tumashu@163.com>
+;; Maintainer: Feng Shu <tumashu@163.com>
+;; URL: https://github.com/tumashu/vertico-posframe
+;; Version: 0.1.0
+;; Keywords: abbrev, convenience, matching, vertico
+;; Package-Requires: ((emacs "26.0") (posframe "1.0.0") (vertico "0.13.0"))
+
+;; This file is 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:
+;; * vertico-posframe README                                :README:
+
+;; ** What is vertico-posframe
+
+;; vertico-posframe is an vertico extension, which lets vertico use posframe 
to show
+;; its candidate menu.
+
+;; NOTE: vertico-posframe requires Emacs 26 and do not support mouse
+;; click.
+
+;; ** How to enable vertico-posframe
+;; #+BEGIN_EXAMPLE
+;; (require 'vertico-posframe)
+;; (vertico-posframe-mode 1)
+;; #+END_EXAMPLE
+
+;; ** Tips
+
+;; *** How to show fringe to vertico-posframe
+;; #+BEGIN_EXAMPLE
+;; (setq vertico-posframe-parameters
+;;       '((left-fringe . 8)
+;;         (right-fringe . 8)))
+;; #+END_EXAMPLE
+
+;; By the way, User can set *any* parameters of vertico-posframe with
+;; the help of `vertico-posframe-parameters'.
+
+;;; Code:
+;; * vertico-posframe's code
+(require 'cl-lib)
+(require 'posframe)
+(require 'vertico)
+
+(defgroup vertico-posframe nil
+  "Using posframe to show vertico"
+  :group 'vertico-posframe)
+
+(defcustom vertico-posframe-font nil
+  "The font used by vertico-posframe.
+When nil, Using current frame's font as fallback."
+  :type 'string)
+
+(defcustom vertico-posframe-width nil
+  "The width of vertico-posframe."
+  :type 'number)
+
+(defcustom vertico-posframe-height nil
+  "The height of vertico-posframe."
+  :type 'number)
+
+(defcustom vertico-posframe-min-width nil
+  "The min width of vertico-posframe."
+  :type 'number)
+
+(defcustom vertico-posframe-min-height nil
+  "The min height of vertico-posframe."
+  :type 'number)
+
+(defcustom vertico-posframe-poshandler #'posframe-poshandler-frame-center
+  "The posframe poshandler used by vertico-posframe."
+  :type 'function)
+
+(defcustom vertico-posframe-refposhandler 
#'vertico-posframe-refposhandler-default
+  "The refposhandler used by vertico-posframe.
+
+NOTE: This variable is very useful to EXWM users."
+  :type 'function)
+
+(defcustom vertico-posframe-size-function #'vertico-posframe-get-size
+  "The function which is used to deal with posframe's size."
+  :type 'function)
+
+(defcustom vertico-posframe-border-width 2
+  "The border width used by vertico-posframe.
+When 0, no border is showed."
+  :type 'number)
+
+(defcustom vertico-posframe-parameters nil
+  "The frame parameters used by vertico-posframe."
+  :type 'string)
+
+(defface vertico-posframe
+  '((t (:inherit default)))
+  "Face used by the vertico-posframe."
+  :group 'vertico-posframe)
+
+(defface vertico-posframe-border
+  '((t (:inherit default :background "gray50")))
+  "Face used by the vertico-posframe's border."
+  :group 'vertico-posframe)
+
+(defface vertico-posframe-cursor
+  '((t (:inherit cursor)))
+  "Face used by the vertico-posframe's fake cursor."
+  :group 'vertico-posframe)
+
+(defvar vertico-posframe--buffer " *vertico-posframe--buffer*")
+(defvar vertico-posframe--overlay)
+
+;; Fix warn
+(defvar exwm--connection)
+(defvar exwm-workspace--workareas)
+(defvar exwm-workspace-current-index)
+
+(defun vertico-posframe-refposhandler-default (&optional frame)
+  "The default posframe refposhandler used by vertico-posframe."
+  (cond
+   ;; EXWM environment
+   ((bound-and-true-p exwm--connection)
+    (or (ignore-errors
+          (let ((info (elt exwm-workspace--workareas
+                           exwm-workspace-current-index)))
+            (cons (elt info 0)
+                  (elt info 1))))
+        ;; Need user install xwininfo.
+        (ignore-errors
+          (posframe-refposhandler-xwininfo frame))
+        ;; Fallback, this value will incorrect sometime, for example: user
+        ;; have panel.
+        (cons 0 0)))
+   (t nil)))
+
+(defun vertico-posframe-hidehandler (_)
+  "Hidehandler used by vertico-posframe."
+  (not (minibufferp)))
+
+(defun vertico-posframe-get-size ()
+  "The default functon used by `vertico-posframe-size-function'."
+  (list
+   :height vertico-posframe-height
+   :width vertico-posframe-width
+   :min-height (or vertico-posframe-min-height
+                   (let ((height (+ vertico-count 1)))
+                     (min height (or vertico-posframe-height height))))
+   :min-width (or vertico-posframe-min-width
+                  (let ((width (round (* (frame-width) 0.62))))
+                    (min width (or vertico-posframe-width width))))))
+
+(defun vertico-posframe--display (lines)
+  "Display LINES in posframe."
+  (let ((count (vertico--format-count))
+        (prompt (minibuffer-prompt))
+        (content (minibuffer-contents)))
+    (with-current-buffer (get-buffer-create vertico-posframe--buffer)
+      (add-hook 'window-selection-change-functions 'vertico-posframe--select 
nil 'local)
+      (setq-local inhibit-modification-hooks t
+                  cursor-in-non-selected-windows 'box)
+      (erase-buffer)
+      (insert (propertize (concat count prompt) 'face 'minibuffer-prompt)
+              content
+              (propertize " " 'face 'vertico-posframe-cursor)
+              "\n" (string-join lines)))
+    (apply #'posframe-show
+           vertico-posframe--buffer
+           :font vertico-posframe-font
+           :poshandler vertico-posframe-poshandler
+           :background-color (face-attribute 'vertico-posframe :background nil 
t)
+           :foreground-color (face-attribute 'vertico-posframe :foreground nil 
t)
+           :internal-border-width vertico-posframe-border-width
+           :internal-border-color (face-attribute 'vertico-posframe-border 
:background nil t)
+           :override-parameters vertico-posframe-parameters
+           :refposhandler vertico-posframe-refposhandler
+           :hidehandler #'vertico-posframe-hidehandler
+           :lines-truncate t
+           (funcall vertico-posframe-size-function))))
+
+(defun vertico-posframe--select (_)
+  "Ensure that cursor is only shown if minibuffer is selected."
+  (with-current-buffer (buffer-local-value 'vertico-posframe--buffer
+                                           (window-buffer 
(active-minibuffer-window)))
+    (if (eq (selected-window) (active-minibuffer-window))
+        (setq-local cursor-in-non-selected-windows 'box)
+      (setq-local cursor-in-non-selected-windows nil)
+      (goto-char (point-min)))))
+
+(defun vertico-posframe--hide ()
+  "Hide vertico buffer."
+  (when (posframe-workable-p)
+    (posframe-hide vertico-posframe--buffer)))
+
+(defun vertico-posframe--setup ()
+  "Setup minibuffer overlay, which pushes the minibuffer content down."
+  (add-hook 'window-selection-change-functions 'vertico-posframe--select nil 
'local)
+  (add-hook 'minibuffer-exit-hook 'vertico-posframe--hide nil 'local)
+  (setq-local cursor-type '(bar . 0))
+  (setq vertico-posframe--overlay (make-overlay (point-max) (point-max) nil t 
t))
+  (overlay-put vertico-posframe--overlay 'window (selected-window))
+  (overlay-put vertico-posframe--overlay 'priority 1000)
+  (overlay-put vertico-posframe--overlay 'before-string "\n"))
+
+;;;###autoload
+(define-minor-mode vertico-posframe-mode
+  "Display Vertico in posframe instead of the minibuffer."
+  :global t
+  (cond
+   (vertico-posframe-mode
+    (advice-add #'vertico--display-candidates :override 
#'vertico-posframe--display)
+    (advice-add #'vertico--setup :after #'vertico-posframe--setup))
+   (t
+    (advice-remove #'vertico--display-candidates #'vertico-posframe--display)
+    (advice-remove #'vertico--setup #'vertico-posframe--setup)
+    (posframe-delete vertico-posframe--buffer))))
+
+(provide 'vertico-posframe)
+;;; vertico-posframe.el ends here