Init commit

README.md

@@ -1 +1,49 @@
-# helm-posframe
+Note: this file is auto converted from helm-posframe.el by [el2org](https://github.com/tumashu/el2org), please do not edit it by hand!!!
+
+
+# 目录
+
+1.  [helm-posframe README](#orgc1a00ba)
+    1.  [What is helm-posframe](#orga243ee0)
+    2.  [How to enable helm-posframe](#org8c1ace2)
+    3.  [Tips](#org60c7d25)
+        1.  [How to show fringe to helm-posframe](#orge36a7d9)
+
+
+<a id="orgc1a00ba"></a>
+
+# helm-posframe README
+
+
+<a id="orga243ee0"></a>
+
+## What is helm-posframe
+
+helm-posframe is a helm extension, which let helm use posframe
+to show its candidate menu.
+
+NOTE: helm-posframe requires Emacs 26
+
+
+<a id="org8c1ace2"></a>
+
+## How to enable helm-posframe
+
+    (helm-posframe-enable)
+
+
+<a id="org60c7d25"></a>
+
+## Tips
+
+
+<a id="orge36a7d9"></a>
+
+### How to show fringe to helm-posframe
+
+    (setq helm-posframe-parameters
+          '((left-fringe . 10)
+            (right-fringe . 10)))
+
+By the way, User can set **any** parameters of helm-posframe with
+the help of \`helm-posframe-parameters'.

helm-posframe.el

@@ -0,0 +1,139 @@
+;;; helm-posframe.el --- Using posframe to show helm window  -*- lexical-binding: t -*-
+
+;; Copyright (C) 2017-2018 Free Software Foundation, Inc.
+
+;; Author: Feng Shu
+;; Maintainer: Feng Shu <tumashu@163.com>
+;; URL: https://github.com/tumashu/helm-posframe
+;; Version: 0.1.0
+;; Keywords: abbrev, convenience, matching, helm
+;; Package-Requires: ((emacs "26.0")(posframe "0.1.0")(helm "0.1"))
+
+;; 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:
+;; * helm-posframe README                                :README:
+
+;; ** What is helm-posframe
+;; helm-posframe is a helm extension, which let helm use posframe
+;; to show its candidate menu.
+
+;; NOTE: helm-posframe requires Emacs 26
+
+;; ** How to enable helm-posframe
+;;    #+BEGIN_EXAMPLE
+;;    (helm-posframe-enable)
+;;    #+END_EXAMPLE
+
+;; ** Tips
+
+;; *** How to show fringe to helm-posframe
+;; ;; #+BEGIN_EXAMPLE
+;; (setq helm-posframe-parameters
+;;       '((left-fringe . 10)
+;;         (right-fringe . 10)))
+;; ;; #+END_EXAMPLE
+
+;; By the way, User can set *any* parameters of helm-posframe with
+;; the help of `helm-posframe-parameters'.
+
+;;; Code:
+;; * helm-posframe's code
+(require 'cl-lib)
+(require 'posframe)
+(require 'helm)
+
+(defgroup helm-posframe nil
+  "Using posframe to show helm menu"
+  :group 'helm
+  :prefix "helm-posframe")
+
+(defcustom helm-posframe-poshandler
+  #'posframe-poshandler-frame-bottom-left-corner
+  "The poshandler of helm-posframe."
+  :group 'helm-posframe
+  :type 'function)
+
+(defcustom helm-posframe-width nil
+  "The width of helm-posframe."
+  :group 'helm-posframe
+  :type 'number)
+
+(defcustom helm-posframe-height nil
+  "The height of helm-posframe."
+  :group 'helm-posframe
+  :type 'number)
+
+(defcustom helm-posframe-font nil
+  "The font used by helm-posframe.
+When nil, Using current frame's font as fallback."
+  :group 'helm-posframe
+  :type 'string)
+
+(defcustom helm-posframe-parameters nil
+  "The frame parameters used by helm-posframe."
+  :group 'helm-posframe
+  :type 'string)
+
+(defvar helm-posframe-buffer nil
+  "The posframe-buffer used by helm-posframe.")
+
+;; Fix warn
+(defvar emacs-basic-display)
+
+(defun helm-posframe-display (buffer &optional _resume)
+  (setq helm-posframe-buffer buffer)
+  (posframe-show
+   buffer
+   :position (point)
+   :poshandler helm-posframe-poshandler
+   :width (or helm-posframe-width (+ (window-width) 2))
+   :height (or helm-posframe-height helm-display-buffer-height)
+   :min-height 10
+   :min-width 50
+   :font helm-posframe-font
+   :override-parameters helm-posframe-parameters
+   :respect-header-line t))
+
+(defun helm-posframe-cleanup ()
+  "Cleanup helm-posframe."
+  (when (helm-posframe-workable-p)
+    (posframe-hide helm-posframe-buffer)))
+
+(defun helm-posframe-workable-p ()
+  "Test helm-posframe workable status."
+  (and (>= emacs-major-version 26)
+       (not (or noninteractive
+                emacs-basic-display
+                (not (display-graphic-p))))))
+
+;;;###autoload
+(defun helm-posframe-enable ()
+  "Enable helm-posframe."
+  (interactive)
+  (require 'helm)
+  (setq helm-display-function #'helm-posframe-display)
+  (add-hook 'helm-cleanup-hook #'helm-posframe-cleanup)
+  (message "helm-posframe is enabled."))
+
+(provide 'helm-posframe)
+
+;; Local Variables:
+;; coding: utf-8-unix
+;; End:
+
+;;; helm-posframe.el ends here