emacs_config/elpa/company-nixos-options-0.0.1/company-nixos-options.el

;;; company-nixos-options.el --- Company Backend for nixos-options

;; Copyright (C) 2015 Diego Berrocal and Travis B. Hartwell

;; Author: Diego Berrocal <cestdiego@gmail.com>
;;      Travis B. Hartwell <nafai@travishartwell.net>
;; Created: 18 July 2015

;; Keywords: unix
;; Package-Version: 0.0.1
;; Package-Commit: 5fc8fa29bea9dd8e9c822af92f9bc6ddc223635f
;; Homepage: http://www.github.com/travisbhartwell/nix-emacs/
;; Version: "0.1.0"
;; Package-Requires: ((company "0.8.0") (nixos-options "0.0.1") (cl-lib "0.5.0"))

;; This file is not part of GNU Emacs.

;;; License: GPLv3

;;; Commentary:

;; Useful functions for exploring the NixOS options.  Inspired by
;; https://nixos.org/nixos/options.html.

;;; Code:
(require 'nixos-options)
(require 'company)
(require 'cl-lib)

(defvar company-nixos-options-keywords
  (mapcar (lambda (nixos-option)
            (list (nixos-options-get-name nixos-option)
                  (nixos-options-get-description nixos-option)))
          nixos-options))

(defun company-nixos-options--make-candidate (candidate)
  (let* ((text (car candidate))
         (meta (cadr candidate)))
    (propertize text 'meta meta)))

;; The following two functions are borrowed from company-anaconda
(defun company-nixos-options--get-property (property candidate)
  "Return the property PROPERTY of completion candidate CANDIDATE."
  (let ((item (get-text-property 0 'item candidate)))
    (plist-get item property)))

(defun company-nixos-options--doc-buffer (candidate)
  "Return documentation buffer for chosen CANDIDATE."
  (let ((doc (nixos-options-get-documentation-for-option
              (nixos-options-get-option-by-name candidate))))
    (and doc (nixos-options-doc-buffer doc))))

(defun company-nixos-options--candidates (prefix)
  (let (res)
    (dolist (item company-nixos-options-keywords)
      (when (string-prefix-p prefix (car item))
        (push (company-nixos-options--make-candidate item) res)))
    res))

(defun company-nixos-options--meta (candidate)
  (format "This will use %s of %s"
          (get-text-property 0 'meta candidate)
          (substring-no-properties candidate)))

(defun company-nixos-options--annotation (candidate)
  (format "  ->  %s" (get-text-property 0 'meta candidate)))

(defun company-nixos--grab-symbol ()
      (buffer-substring (point) (save-excursion (skip-syntax-backward "w_.")
                                                (point))))

(defun company-nixos-options--prefix ()
  "Grab prefix at point."
  (or (company-nixos--grab-symbol)
      'stop))

;;;###autoload
(defun company-nixos-options (command &optional arg &rest ignored)
  (interactive (list 'interactive))
  (cl-case command
    (interactive (company-begin-backend 'company-nixos-options))
    (prefix (company-nixos-options--prefix))
    (candidates (company-nixos-options--candidates arg))
    (doc-buffer (company-nixos-options--doc-buffer arg))
    ;; (annotation (company-nixos-options--annotation arg))
    (meta (company-nixos-options--meta arg))))

(provide 'company-nixos-options)

;;; company-nixos-options.el ends here