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

   1 ;;; company-gtags.el --- company-mode completion back-end for GNU Global
   2
   3 ;; Copyright (C) 2009-2011, 2014  Free Software Foundation, Inc.
   4
   5 ;; Author: Nikolaj Schumacher
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software: you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation, either version 3 of the License, or
  12 ;; (at your option) any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  21
  22
  23 ;;; Commentary:
  24 ;;
  25
  26 ;;; Code:
  27
  28 (require 'company)
  29 (require 'cl-lib)
  30
  31 (defgroup company-gtags nil
  32   "Completion back-end for GNU Global."
  33   :group 'company)
  34
  35 (defcustom company-gtags-executable
  36   (executable-find "global")
  37   "Location of GNU global executable."
  38   :type 'string)
  39
  40 (define-obsolete-variable-alias
  41   'company-gtags-gnu-global-program-name
  42   'company-gtags-executable "earlier")
  43
  44 (defvar-local company-gtags--tags-available-p 'unknown)
  45
  46 (defvar company-gtags-modes '(c-mode c++-mode jde-mode java-mode php-mode))
  47
  48 (defun company-gtags--tags-available-p ()
  49   (if (eq company-gtags--tags-available-p 'unknown)
  50       (setq company-gtags--tags-available-p
  51             (locate-dominating-file buffer-file-name "GTAGS"))
  52     company-gtags--tags-available-p))
  53
  54 (defun company-gtags-fetch-tags (prefix)
  55   (with-temp-buffer
  56     (let (tags)
  57       (when (= 0 (call-process company-gtags-executable nil
  58                                (list (current-buffer) nil) nil "-xGq" (concat "^" prefix)))
  59         (goto-char (point-min))
  60         (cl-loop while
  61                  (re-search-forward (concat
  62                                      "^"
  63                                      "\\([^ ]*\\)" ;; completion
  64                                      "[ \t]+\\([[:digit:]]+\\)" ;; linum
  65                                      "[ \t]+\\([^ \t]+\\)" ;; file
  66                                      "[ \t]+\\(.*\\)" ;; definition
  67                                      "$"
  68                                      ) nil t)
  69                  collect
  70                  (propertize (match-string 1)
  71                              'meta (match-string 4)
  72                              'location (cons (expand-file-name (match-string 3))
  73                                              (string-to-number (match-string 2)))
  74                              ))))))
  75
  76 ;;;###autoload
  77 (defun company-gtags (command &optional arg &rest ignored)
  78   "`company-mode' completion back-end for GNU Global."
  79   (interactive (list 'interactive))
  80   (cl-case command
  81     (interactive (company-begin-backend 'company-gtags))
  82     (prefix (and company-gtags-executable
  83                  (memq major-mode company-gtags-modes)
  84                  (not (company-in-string-or-comment))
  85                  (company-gtags--tags-available-p)
  86                  (or (company-grab-symbol) 'stop)))
  87     (candidates (company-gtags-fetch-tags arg))
  88     (sorted t)
  89     (duplicates t)
  90     (annotation (let ((meta (get-text-property 0 'meta arg)))
  91                   (when (string-match (concat arg "\\((.*)\\).*") meta)
  92                     (match-string 1 meta))))
  93     (meta (get-text-property 0 'meta arg))
  94     (location (get-text-property 0 'location arg))))
  95
  96 (provide 'company-gtags)
  97 ;;; company-gtags.el ends here