File: racket-doc.el

package info (click to toggle)
racket-mode 20210916git0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,076 kB
  • sloc: lisp: 10,354; makefile: 58
file content (66 lines) | stat: -rw-r--r-- 2,698 bytes parent folder | download
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
;;; 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

;; License:
;; This is free software; you can redistribute it and/or modify it
;; under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version. This is distributed in the hope that it will be
;; useful, but without any warranty; without even the implied warranty
;; of merchantability or fitness for a particular purpose. See the GNU
;; General Public License for more details. See
;; http://www.gnu.org/licenses/ for details.

(require 'racket-browse-url)
(require 'racket-cmd)
(require 'racket-custom)
(require 'racket-util)
(declare-function racket--repl-session-id "racket-repl.el" ())

(defun racket--doc (prefix how completions)
  "A helper for `racket-xp-documentation' and `racket-repl-documentation'."
  (let ((search-p (equal prefix '(16))))
    (pcase (racket--symbol-at-point-or-prompt prefix
                                              "Documentation for: "
                                              (unless search-p completions)
                                              search-p)
      ((and (pred stringp) str)
       (if search-p
           (racket--search-doc str)
         (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."
  (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 str)))
    ('local                   (racket--search-doc-locally str))))

(defun racket--search-doc-locally (str)
  (call-process (expand-file-name racket-program)
                nil ;INFILE: none
                0   ;DESTINATION: discard/don't wait
                nil ;DISPLAY: none
                "-l" "raco" "docs" str))

(provide 'racket-doc)

;; racket-doc.el ends here