helm-gtags.el is GNU GLOBAL helm interface.
helm-gtags.el is not compatible anything-gtags.el.
But helm-gtags.el is designed for faster search than anything-gtags.el.
anything-gtags.el is slow in large source tree such as Linux kernel,
FreeBSD, Android etc. Because anything-gtags.el creates candidates
by processing output of gtags.el. helm-gtags.el creates candidates
by itself, so helm-gtags.el is faster than anything-gtags.el.
- Emacs 23 or higher.
- helm 1.8 or higher
- GNU Global 6.2.3 or higher
helm-gtags.el does not require gtags.el.
Enable helm-gtags-mode.
helm-gtags-find-tag and helm-gtags-find-symbol
Complete symbol at point(help writing code).
Input tag name and move to the referenced point.
Input file name and open it.
Input symbol and move to the locations.
Input tag name and move to the definition.
Find tag from here and move to its definition (gnu global --from-here).
Update TAG file. Default is update only current file.
You can update all files with C-u prefix.
You can generate new tags with C-uC-u prefix.
Show symbols in current file like gtags-parse-file. You can choose
any files with C-u prefix.
You could add your lib directory here ,like
(setq helm-gtags-GTAGSLIBPATH-alist
'(("/path/to/project1" "/usr/include/" "/usr/kernel/")
("/path/to/project2" "/path/of/tag/2/" "/path/of/tag/3/")))
"/path/to/project1" and "/path/to/project2" can NOT ends with /
;;or
;;(helm-gtags-set-GTAGSLIBPATH-alist "~/repos/emacs/" '("/usr/include" "/usr/local/include"))
;;(helm-gtags-set-GTAGSLIBPATH-alist "~/repos/demo_opencv/" '("/usr/include" "/usr/local/Cellar/opencv3/3.0.0/include/" "/usr/local/include"))
you neednot set this if you just use one tag
of cource you should run :
gtags
in these directories.
then
helm-gtags-find-symbol
helm-gtags-find-rtag
helm-gtags-find-tag
helm-gtags-find-tag-and-symbol
helm-gtags-find-tag-from-here
helm-gtags-find-files
helm-gtags-complete
could find tag rtags symbol files in several directory with one command.
with prefix C-u :using other window.
with prefix C-uC-u :do not use symbol-at-point as default input.
File path style, 'root or 'relative or 'absolute(Default is 'root)
Ignore case for searching flag (Default is nil)
Open file as readonly, if this value is non-nil(Default is nil).
If this variable is non-nil, TAG file is updated after saving buffer.
helm-input-idle-delay for helm-gtags
do not support history navigate feature directly. if you want this feature, you just need use helm-gtags-select-before-hook and helm-gtags-goto-line-before-hook
https://github.com/joodland/bm https://github.com/jixiuf/helm-bm
you just need this lines:
(autoload 'bm-toggle "bm" "Toggle bookmark in current buffer." t)
(autoload 'bm-next "bm" "Goto bookmark." t)
(autoload 'bm-previous "bm" "Goto previous bookmark." t)
(global-set-key (kbd "<C-f2>") 'bm-toggle)
(global-set-key (kbd "M-,") 'bm-next)
(global-set-key (kbd "M-/") 'bm-previous)
(setq bm-highlight-style 'bm-highlight-only-fringe)
(setq bm-cycle-all-buffers t)
(autoload 'helm-bm "helm-bm" "List All Bookmarks with helm.el." t)
(global-set-key (kbd "M-*") 'helm-bm)
(require 'helm-gtags)
(autoload 'bm-bookmark-add "bm" "Add bookmark at current line.")
(add-hook 'helm-gtags-goto-line-before-hook 'bm-bookmark-add)
(add-hook 'helm-gtags-quit-or-no-candidates-hook 'bm-bookmark-remove) ;if jump fail ,remove the unnecessary bookmark
(add-hook 'helm-gtags-goto-line-after-hook 'bm-bookmark-remove) ;after jump ,if there is a bookmark there,remove it if you want
;;; and other helm-gtags.el configuration
emacs default bookmark doesnot provide bookmark-next or bookmark-previous so I write https://github.com/jixiuf/bookmark-cycle and with the helm-bookmark.el in https://github.com/emacs-helm/helm
;; first: you should
(require 'bookmark)
(setq bookmark-sort-flag nil) ;
(setq bookmark-bmenu-file-column 120) ;
;; then:
(global-set-key (kbd "<C-f2>") 'bookmark-cycle-push)
(global-set-key (kbd "M-,") 'bookmark-cycle-next)
(global-set-key (kbd "M-/") 'bookmark-cycle-previous)
(require 'helm-bookmark)
(setq helm-bookmark-show-location t) ;
(define-key global-map (kbd "M-*") 'helm-pp-bookmarks);; in helm-bookmark.el
(require 'helm-gtags)
(add-hook 'helm-gtags-goto-line-before-hook 'bookmark-cycle-push)
these package lets you cycle among bookmarks if you donot want use bookmark-cycle.el.
http://www.emacswiki.org/emacs/BookmarkPlus
http://www.emacswiki.org/emacs/bookmark-add.el
http://www.emacswiki.org/emacs/BookMarks
(require 'helm-config)
(require 'helm-gtags)
;;; Enable helm-gtags-mode
(add-hook 'c-mode-hook 'helm-gtags-mode)
(add-hook 'c++-mode-hook 'helm-gtags-mode)
(add-hook 'asm-mode-hook 'helm-gtags-mode)
;; customize
(setq helm-gtags-path-style 'relative)
(setq helm-gtags-ignore-case t)
(setq helm-gtags-read-only t)
(setq helm-gtags-auto-update t)
;;you neednot set this if you just use one tag
(setq helm-gtags-GTAGSLIBPATH-alist
'(
("~/repos/emacs/" "/usr/include/" "/usr/local/include")
("/Users/admin/repos/hello_c/opencv" "/usr/local/Cellar/opencv3/3.0.0/include/" "/usr/local/include")
))
;;(helm-gtags-set-GTAGSLIBPATH-alist "~/repos/emacs/" '("/usr/include" "/usr/local/include"))
;;(helm-gtags-set-GTAGSLIBPATH-alist "~/repos/demo_opencv/" '("/usr/include" "/usr/local/Cellar/opencv3/3.0.0/include/" "/usr/local/include"))
(eval-after-load "helm-gtags" '(add-to-list 'helm-for-files-preferred-list helm-source-gtags-files t))
;; key bindings
;;with prefix C-u :using other window.
;;with prefix C-uC-u :do not use symbol-at-point as default input.
(add-hook 'helm-gtags-mode-hook
'(lambda ()
(local-set-key [(meta return)] 'helm-gtags-complete)
(local-set-key (kbd "M-.") 'helm-gtags-find-tag-and-symbol)
(local-set-key (kbd "M-t") 'helm-gtags-find-tag)
(local-set-key (kbd "M-s") 'helm-gtags-find-symbol)
(local-set-key (kbd "M-r") 'helm-gtags-find-rtag)
(local-set-key (kbd "M-g M-p") 'helm-gtags-parse-file)
(local-set-key (kbd "C-c C-f") 'helm-gtags-find-files)))(defun goto-definition (&optional arg)
"Make use of emacs' find-func and etags possibilities for finding definitions."
(interactive "P")
(let ((line (buffer-substring-no-properties
(line-beginning-position) (line-end-position)))
;; (marker (point-marker))
)
;;(bm-bookmark-add line nil t)
(case major-mode
(c++-mode
(if (string-match "[ ]*#[ \t]*include[ \t]+[\"<]\\(.*\\)[\">]" line)
;; for c++-mode ,in current line contains #include ,then try to open the include file using helm-gtags
(helm-gtags-find-files (match-string 1 line))
(helm-gtags-find-tag-and-symbol)))
(c-mode
(if (string-match "[ ]*#[ \t]*include[ \t]+[\"<]\\(.*\\)[\">]" line)
;; for c-mode ,in current line contains #include ,then try to open the include file using helm-gtags
(helm-gtags-find-files (match-string 1 line))
(helm-gtags-find-tag-and-symbol)))
(emacs-lisp-mode
(if (or (string-match "(\\brequire\\b" line) (string-match "(\\bprovide\\b" line))
(find-file (find-library-name (symbol-name (symbol-at-point))))
(condition-case nil
(if (or (functionp (symbol-at-point))(macrop (symbol-at-point)))
(find-function (symbol-at-point))
(condition-case nil
(when (variable-at-point) (find-variable (symbol-at-point)))
(error (helm-gtags-find-tag-and-symbol))))
)))
(otherwise
(helm-gtags-find-tag-and-symbol)))
(setq this-command 'goto-definition)
)
;; (add-hook 'helm-gtags-quit-or-no-candidates-hook 'bm-bookmark-remove)