14b2395424
doom-debug-p and doom-interactive-p have always been intentionally redundant, because changing the variables they replaced had other side-effects, which made writing tests for them difficult. Since our new (yet unpublished) tests lean heavily toward integration testing more than unit testing, this becomes an implementation detail. And doom-init-p's only use was refactor out at some point in the past, so it's no longer used. Also done to reduce Doom's footprint, in general.
225 lines
8.8 KiB
EmacsLisp
225 lines
8.8 KiB
EmacsLisp
;;; tools/lookup/config.el -*- lexical-binding: t; -*-
|
|
|
|
;; "What am I looking at?" This module helps you answer this question.
|
|
;;
|
|
;; + `+lookup/definition': a jump-to-definition that should 'just work'
|
|
;; + `+lookup/implementations': find a symbol's implementations in the current
|
|
;; project
|
|
;; + `+lookup/references': find a symbol's references in the current project
|
|
;; + `+lookup/file': open the file referenced at point
|
|
;; + `+lookup/online'; look up a symbol on online resources
|
|
;; + `+lookup/in-docsets': look up in Dash docsets
|
|
;;
|
|
;; This module uses `xref', an experimental new library in Emacs. It may change
|
|
;; in the future. When xref can't be depended on it will fall back to
|
|
;; `dumb-jump' to find what you want.
|
|
|
|
(defvar +lookup-provider-url-alist
|
|
(append '(("Doom Emacs issues" "https://github.com/hlissner/doom-emacs/issues?q=is%%3Aissue+%s")
|
|
("Google" +lookup--online-backend-google "https://google.com/search?q=%s")
|
|
("Google images" "https://www.google.com/images?q=%s")
|
|
("Google maps" "https://maps.google.com/maps?q=%s")
|
|
("Project Gutenberg" "http://www.gutenberg.org/ebooks/search/?query=%s")
|
|
("DuckDuckGo" +lookup--online-backend-duckduckgo "https://duckduckgo.com/?q=%s")
|
|
("DevDocs.io" "https://devdocs.io/#q=%s")
|
|
("StackOverflow" "https://stackoverflow.com/search?q=%s")
|
|
("Github" "https://github.com/search?ref=simplesearch&q=%s")
|
|
("Youtube" "https://youtube.com/results?aq=f&oq=&search_query=%s")
|
|
("Wolfram alpha" "https://wolframalpha.com/input/?i=%s")
|
|
("Wikipedia" "https://wikipedia.org/search-redirect.php?language=en&go=Go&search=%s")
|
|
("MDN" "https://developer.mozilla.org/en-US/search?q=%s"))
|
|
(when (featurep! :lang rust)
|
|
'(("Rust Docs" "https://doc.rust-lang.org/std/?search=%s"))))
|
|
"An alist that maps online resources to either:
|
|
|
|
1. A search url (needs on '%s' to substitute with an url encoded query),
|
|
2. A non-interactive function that returns the search url in #1,
|
|
3. An interactive command that does its own search for that provider.
|
|
|
|
Used by `+lookup/online'.")
|
|
|
|
(defvar +lookup-open-url-fn #'browse-url
|
|
"Function to use to open search urls.")
|
|
|
|
(defvar +lookup-definition-functions
|
|
'(+lookup-dictionary-definition-backend-fn
|
|
+lookup-xref-definitions-backend-fn
|
|
+lookup-dumb-jump-backend-fn
|
|
+lookup-project-search-backend-fn
|
|
+lookup-evil-goto-definition-backend-fn)
|
|
"Functions for `+lookup/definition' to try, before resorting to `dumb-jump'.
|
|
Stops at the first function to return non-nil or change the current
|
|
window/point.
|
|
|
|
If the argument is interactive (satisfies `commandp'), it is called with
|
|
`call-interactively' (with no arguments). Otherwise, it is called with one
|
|
argument: the identifier at point. See `set-lookup-handlers!' about adding to
|
|
this list.")
|
|
|
|
(defvar +lookup-implementations-functions ()
|
|
"Function for `+lookup/implementations' to try. Stops at the first function to
|
|
return non-nil or change the current window/point.
|
|
|
|
If the argument is interactive (satisfies `commandp'), it is called with
|
|
`call-interactively' (with no arguments). Otherwise, it is called with one
|
|
argument: the identifier at point. See `set-lookup-handlers!' about adding to
|
|
this list.")
|
|
|
|
(defvar +lookup-type-definition-functions ()
|
|
"Functions for `+lookup/type-definition' to try. Stops at the first function to
|
|
return non-nil or change the current window/point.
|
|
|
|
If the argument is interactive (satisfies `commandp'), it is called with
|
|
`call-interactively' (with no arguments). Otherwise, it is called with one
|
|
argument: the identifier at point. See `set-lookup-handlers!' about adding to
|
|
this list.")
|
|
|
|
(defvar +lookup-references-functions
|
|
'(+lookup-thesaurus-definition-backend-fn
|
|
+lookup-xref-references-backend-fn
|
|
+lookup-project-search-backend-fn)
|
|
"Functions for `+lookup/references' to try, before resorting to `dumb-jump'.
|
|
Stops at the first function to return non-nil or change the current
|
|
window/point.
|
|
|
|
If the argument is interactive (satisfies `commandp'), it is called with
|
|
`call-interactively' (with no arguments). Otherwise, it is called with one
|
|
argument: the identifier at point. See `set-lookup-handlers!' about adding to
|
|
this list.")
|
|
|
|
(defvar +lookup-documentation-functions
|
|
'(+lookup-online-backend-fn)
|
|
"Functions for `+lookup/documentation' to try, before resorting to
|
|
`dumb-jump'. Stops at the first function to return non-nil or change the current
|
|
window/point.
|
|
|
|
If the argument is interactive (satisfies `commandp'), it is called with
|
|
`call-interactively' (with no arguments). Otherwise, it is called with one
|
|
argument: the identifier at point. See `set-lookup-handlers!' about adding to
|
|
this list.")
|
|
|
|
(defvar +lookup-file-functions
|
|
'(+lookup-bug-reference-backend-fn
|
|
+lookup-ffap-backend-fn)
|
|
"Function for `+lookup/file' to try, before restoring to `find-file-at-point'.
|
|
Stops at the first function to return non-nil or change the current
|
|
window/point.
|
|
|
|
If the argument is interactive (satisfies `commandp'), it is called with
|
|
`call-interactively' (with no arguments). Otherwise, it is called with one
|
|
argument: the identifier at point. See `set-lookup-handlers!' about adding to
|
|
this list.")
|
|
|
|
(defvar +lookup-dictionary-prefer-offline (featurep! +offline)
|
|
"If non-nil, look up dictionaries online.
|
|
|
|
Setting this to nil will force it to use offline backends, which may be less
|
|
than perfect, but available without an internet connection.
|
|
|
|
Used by `+lookup/dictionary-definition' and `+lookup/synonyms'.
|
|
|
|
For `+lookup/dictionary-definition', this is ignored on Mac, where Emacs users
|
|
Dictionary.app behind the scenes to get definitions.")
|
|
|
|
|
|
;;
|
|
;;; dumb-jump
|
|
|
|
(use-package! dumb-jump
|
|
:commands dumb-jump-result-follow
|
|
:config
|
|
(setq dumb-jump-default-project doom-emacs-dir
|
|
dumb-jump-prefer-searcher 'rg
|
|
dumb-jump-aggressive nil
|
|
dumb-jump-selector
|
|
(cond ((featurep! :completion ivy) 'ivy)
|
|
((featurep! :completion helm) 'helm)
|
|
('popup)))
|
|
(add-hook 'dumb-jump-after-jump-hook #'better-jumper-set-jump))
|
|
|
|
|
|
;;
|
|
;;; xref
|
|
|
|
;; The lookup commands are superior, and will consult xref if there are no
|
|
;; better backends available.
|
|
(global-set-key [remap xref-find-definitions] #'+lookup/definition)
|
|
(global-set-key [remap xref-find-references] #'+lookup/references)
|
|
|
|
(after! xref
|
|
;; We already have `projectile-find-tag' and `evil-jump-to-tag', no need for
|
|
;; xref to be one too.
|
|
(remove-hook 'xref-backend-functions #'etags--xref-backend)
|
|
;; ...however, it breaks `projectile-find-tag', unless we put it back.
|
|
(defadvice! +lookup--projectile-find-tag-a (fn)
|
|
:around #'projectile-find-tag
|
|
(let ((xref-backend-functions '(etags--xref-backend t)))
|
|
(funcall fn)))
|
|
|
|
;; This integration is already built into evil
|
|
(unless (featurep! :editor evil)
|
|
;; Use `better-jumper' instead of xref's marker stack
|
|
(advice-add #'xref-push-marker-stack :around #'doom-set-jump-a))
|
|
|
|
(use-package! ivy-xref
|
|
:when (featurep! :completion ivy)
|
|
:config
|
|
(set-popup-rule! "^\\*xref\\*$" :ignore t)
|
|
(setq xref-show-definitions-function #'ivy-xref-show-defs
|
|
xref-show-xrefs-function #'ivy-xref-show-xrefs)
|
|
|
|
;; HACK Fix #4386: `ivy-xref-show-xrefs' calls `fetcher' twice, which has
|
|
;; side effects that breaks in some cases (i.e. on `dired-do-find-regexp').
|
|
(defadvice! +lookup--fix-ivy-xrefs (fn fetcher alist)
|
|
:around #'ivy-xref-show-xrefs
|
|
(when (functionp fetcher)
|
|
(setf (alist-get 'fetched-xrefs alist)
|
|
(funcall fetcher)))
|
|
(funcall fn fetcher alist)))
|
|
|
|
(use-package! helm-xref
|
|
:when (featurep! :completion helm))
|
|
|
|
(use-package! consult-xref
|
|
:when (featurep! :completion vertico)
|
|
:defer t
|
|
:init
|
|
(setq xref-show-xrefs-function #'consult-xref
|
|
xref-show-definitions-function #'consult-xref)))
|
|
|
|
|
|
;;
|
|
;;; Dash docset integration
|
|
|
|
(use-package! dash-docs
|
|
:when (featurep! +docsets)
|
|
:defer t
|
|
:init
|
|
(add-hook '+lookup-documentation-functions #'+lookup-dash-docsets-backend-fn)
|
|
:config
|
|
(setq dash-docs-enable-debugging init-file-debug
|
|
dash-docs-docsets-path (concat doom-etc-dir "docsets/")
|
|
dash-docs-min-length 2
|
|
dash-docs-browser-func #'eww)
|
|
|
|
(cond ((featurep! :completion helm)
|
|
(require 'helm-dash nil t))
|
|
((featurep! :completion ivy)
|
|
(require 'counsel-dash nil t))))
|
|
|
|
|
|
;;
|
|
;;; Dictionary integration
|
|
|
|
(use-package! define-word
|
|
:when (featurep! +dictionary)
|
|
:unless IS-MAC
|
|
:defer t
|
|
:config
|
|
(setq define-word-displayfn-alist
|
|
(cl-loop for (service . _) in define-word-services
|
|
collect (cons service #'+eval-display-results-in-popup))))
|
|
|
|
|
|
;;;###package synosaurus
|
|
(setq synosaurus-choose-method 'default) ; use ivy/helm instead of ido
|