1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
;;; racket-doc.el -*- lexical-binding: t -*-
;; Copyright (c) 2020 by Greg Hendershott.
;; Portions Copyright (C) 1985-1986, 1999-2013 Free Software Foundation, Inc.
;; Author: Greg Hendershott
;; URL: https://github.com/greghendershott/racket-mode
;; SPDX-License-Identifier: GPL-3.0-or-later
(require 'url-util)
(require 'racket-browse-url)
(require 'racket-cmd)
(require 'racket-custom)
(require 'racket-util)
(require 'racket-back-end)
(declare-function racket--repl-session-id "racket-repl.el" ())
(defun racket--doc-assert-local-back-end ()
(unless (racket--back-end-local-p)
(user-error "Cannot use web browser to browse remote documentation; instead use `racket-describe'")))
(defun racket--doc (prefix how completions)
"A helper for `racket-xp-documentation' and `racket-repl-documentation'."
(racket--doc-assert-local-back-end)
(cond
((equal prefix '(16))
(when-let (str (read-from-minibuffer
"Search documentation for text: "))
(racket--search-doc str)))
(t
(when-let (str (racket--symbol-at-point-or-prompt
prefix
"Documentation for: "
completions))
(racket--doc-command (when (eq how 'namespace)
(racket--repl-session-id))
how
str)))))
(defun racket--doc-command (repl-session-id how str)
"A helper for `racket--doc', `racket-xp-describe', and `racket-repl-describe'.
Centralizes how to issue doc command and handle response correctly."
(let ((how (racket-how-front-to-back how)))
(racket--cmd/async repl-session-id
`(doc ,how ,str)
(lambda (maybe-url)
(if maybe-url
(racket-browse-url maybe-url)
(racket--search-doc str))))))
(defun racket--search-doc (str)
"Search docs where the variable `racket-documentation-search-location' says."
(pcase racket-documentation-search-location
((and (pred stringp) url) (racket-browse-url (format url (url-hexify-string str))))
('local (racket--search-doc-locally str))
(_ (user-error "Unknown value for `racket-documentation-search-location': %s"
racket-documentation-search-location))))
(defun racket--search-doc-locally (str)
(racket--doc-assert-local-back-end)
(let ((command (if (stringp racket-program)
(list racket-program)
racket-program)))
(apply #'call-process `(,(car command)
nil ;INFILE: none
0 ;DESTINATION: discard/don't wait
nil ;DISPLAY: none
,@(cdr command)
"-l" "raco" "docs" ,str))))
(provide 'racket-doc)
;; racket-doc.el ends here
|