code.delx.au - gnu-emacs-elpa/blob - company-cmake.el

   1 ;;; company-cmake.el --- company-mode completion back-end for CMake
   2
   3 ;; Copyright (C) 2013-2014  Free Software Foundation, Inc.
   4
   5 ;; Author: Chen Bin <chenbin DOT sh AT gmail>
   6 ;; Version: 0.2
   7
   8 ;; This program is free software: you can redistribute it and/or modify
   9 ;; it under the terms of the GNU General Public License as published by
  10 ;; the Free Software Foundation, either version 3 of the License, or
  11 ;; (at your option) any later version.
  12
  13 ;; This program is distributed in the hope that it will be useful,
  14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 ;; GNU General Public License for more details.
  17
  18 ;; You should have received a copy of the GNU General Public License
  19 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 ;;; Commentary:
  22 ;;
  23 ;; company-cmake offers completions for module names, variable names and
  24 ;; commands used by CMake.  And their descriptions.
  25
  26 ;;; Code:
  27
  28 (require 'company)
  29 (require 'cl-lib)
  30
  31 (defgroup company-cmake nil
  32   "Completion back-end for CMake."
  33   :group 'company)
  34
  35 (defcustom company-cmake-executable
  36   (executable-find "cmake")
  37   "Location of cmake executable."
  38   :type 'file)
  39
  40 (defvar company-cmake-executable-arguments
  41   '("--help-command-list"
  42     "--help-module-list"
  43     "--help-variable-list")
  44   "The arguments we pass to cmake, separately.
  45 They affect which types of symbols we get completion candidates for.")
  46
  47 (defvar company-cmake--completion-pattern
  48   "^\\(%s[a-zA-Z0-9_<>]%s\\)$"
  49   "Regexp to match the candidates.")
  50
  51 (defvar company-cmake-modes '(cmake-mode)
  52   "Major modes in which cmake may complete.")
  53
  54 (defvar company-cmake--candidates-cache nil
  55   "Cache for the raw candidates.")
  56
  57 (defvar company-cmake--meta-command-cache nil
  58   "Cache for command arguments to retrieve descriptions for the candidates.")
  59
  60 (defun company-cmake--replace-tags (rlt)
  61   (setq rlt (replace-regexp-in-string
  62              "\\(.*\\)<LANG>\\(.*\\)"
  63              (mapconcat 'identity '("\\1CXX\\2" "\\1C\\2" "\\1G77\\2") "\n")
  64              rlt))
  65   (setq rlt (replace-regexp-in-string
  66              "\\(.*\\)<CONFIG>\\(.*\\)"
  67              (mapconcat 'identity '("\\1DEBUG\\2" "\\1RELEASE\\2"
  68                                     "\\1RELWITHDEBINFO\\2" "\\1MINSIZEREL\\2")
  69                         "\n")
  70              rlt))
  71   rlt)
  72
  73 (defun company-cmake--fill-candidates-cache (arg)
  74   "Fill candidates cache if needed."
  75   (let (rlt)
  76     (unless company-cmake--candidates-cache
  77       (setq company-cmake--candidates-cache (make-hash-table :test 'equal)))
  78
  79     ;; If hash is empty, fill it.
  80     (unless (gethash arg company-cmake--candidates-cache)
  81       (with-temp-buffer
  82         (let ((res (call-process company-cmake-executable nil t nil arg)))
  83           (unless (zerop res)
  84             (message "cmake executable exited with error=%d" res)))
  85         (setq rlt (buffer-string)))
  86       (setq rlt (company-cmake--replace-tags rlt))
  87       (puthash arg rlt company-cmake--candidates-cache))
  88     ))
  89
  90 (defun company-cmake--parse (prefix content cmd)
  91   (let ((start 0)
  92         (pattern (format company-cmake--completion-pattern
  93                          (regexp-quote prefix)
  94                          (if (zerop (length prefix)) "+" "*")))
  95         (lines (split-string content "\n"))
  96         match
  97         rlt)
  98     (dolist (line lines)
  99       (when (string-match pattern line)
 100         (let ((match (match-string 1 line)))
 101           (when match
 102             (puthash match cmd company-cmake--meta-command-cache)
 103             (push match rlt)))))
 104     rlt))
 105
 106 (defun company-cmake--candidates (prefix)
 107   (let (results
 108         cmd-opts
 109         str)
 110
 111     (unless company-cmake--meta-command-cache
 112       (setq company-cmake--meta-command-cache (make-hash-table :test 'equal)))
 113
 114     (dolist (arg company-cmake-executable-arguments)
 115       (company-cmake--fill-candidates-cache arg)
 116       (setq cmd-opts (replace-regexp-in-string "-list$" "" arg) )
 117
 118       (setq str (gethash arg company-cmake--candidates-cache))
 119       (when str
 120         (setq results (nconc results
 121                              (company-cmake--parse prefix str cmd-opts)))))
 122     results))
 123
 124 (defun company-cmake--unexpand-candidate (candidate)
 125   (cond
 126    ((string-match "^CMAKE_\\(C\\|CXX\\|G77\\)\\(_.*\\)$" candidate)
 127     (setq candidate (concat "CMAKE_<LANG>" (match-string 2 candidate))))
 128
 129    ;; C flags
 130    ((string-match "^\\(.*_\\)IS_GNU\\(C\\|CXX\\|G77\\)$" candidate)
 131     (setq candidate (concat (match-string 1 candidate) "IS_GNU<LANG>")))
 132
 133    ;; C flags
 134    ((string-match "^\\(.*_\\)OVERRIDE_\\(C\\|CXX\\|G77\\)$" candidate)
 135     (setq candidate (concat (match-string 1 candidate) "OVERRIDE_<LANG>")))
 136
 137    ((string-match "^\\(.*\\)\\(_DEBUG\\|_RELEASE\\|_RELWITHDEBINFO\\|_MINSIZEREL\\)\\(.*\\)$" candidate)
 138     (setq candidate (concat (match-string 1 candidate)
 139                             "_<CONFIG>"
 140                             (match-string 3 candidate)))))
 141   candidate)
 142
 143 (defun company-cmake--meta (candidate)
 144   (let ((cmd-opts (gethash candidate company-cmake--meta-command-cache))
 145         result)
 146     (setq candidate (company-cmake--unexpand-candidate candidate))
 147
 148     ;; Don't cache the documentation of every candidate (command)
 149     ;; Cache in this case will cost too much memory.
 150     (with-temp-buffer
 151       (call-process company-cmake-executable nil t nil cmd-opts candidate)
 152       ;; Go to the third line, trim it and return the result.
 153       ;; Tested with cmake 2.8.9.
 154       (goto-char (point-min))
 155       (forward-line 2)
 156       (setq result (buffer-substring-no-properties (line-beginning-position)
 157                                                    (line-end-position)))
 158       (setq result (replace-regexp-in-string "^[ \t\n\r]+" "" result))
 159       result)))
 160
 161 (defun company-cmake--doc-buffer (candidate)
 162   (let ((cmd-opts (gethash candidate company-cmake--meta-command-cache)))
 163
 164     (setq candidate (company-cmake--unexpand-candidate candidate))
 165     (with-temp-buffer
 166       (call-process company-cmake-executable nil t nil cmd-opts candidate)
 167       ;; Go to the third line, trim it and return the doc buffer.
 168       ;; Tested with cmake 2.8.9.
 169       (goto-char (point-min))
 170       (forward-line 2)
 171       (company-doc-buffer
 172        (buffer-substring-no-properties (line-beginning-position)
 173                                        (point-max))))))
 174
 175 (defun company-cmake (command &optional arg &rest ignored)
 176   "`company-mode' completion back-end for CMake.
 177 CMake is a cross-platform, open-source make system."
 178   (interactive (list 'interactive))
 179   (cl-case command
 180     (interactive (company-begin-backend 'company-cmake))
 181     (init (when (memq major-mode company-cmake-modes)
 182             (unless company-cmake-executable
 183               (error "Company found no cmake executable"))))
 184     (prefix (and (memq major-mode company-cmake-modes)
 185                  (not (company-in-string-or-comment))
 186                  (company-grab-symbol)))
 187     (candidates (company-cmake--candidates arg))
 188     (meta (company-cmake--meta arg))
 189     (doc-buffer (company-cmake--doc-buffer arg))
 190     ))
 191
 192 (provide 'company-cmake)
 193 ;;; company-cmake.el ends here