Skip to content

Commit

Permalink
Use more string values
Browse files Browse the repository at this point in the history 
Since the new exported-index-desc*-extra 'kind value is a string, do
likewise elsewhere (instead of symbols).

Also handle from-libs as a string.

Also refine the sorting:

 - Also sort rhombus specially.

 - Sort "from no libs" (e.g. docs) last.
  • Loading branch information
@greghendershott
greghendershott committed Sep 30, 2024
1 parent 43fc2bf commit 186ad56
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 60 deletions.
29 changes: 11 additions & 18 deletions racket-describe.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -607,24 +607,17 @@ point if any.
(setq tabulated-list-entries
(mapcar
(pcase-lambda (`(,term ,what ,from ,path ,anchor))
(let ((from (format "%s" from))
(what (pcase what
(`(,m . ,c) (concat (symbol-name m)
" of "
(symbol-name c)))
(`() "")
(_ (symbol-name what)))))
(setq max-term (max max-term (length term)))
(setq max-what (max max-what (length what)))
(list nil
(vector
(list term
'name term
'path (racket-file-name-back-to-front path)
'anchor anchor
'action #'racket-describe-search-button)
what
from))))
(setq max-term (max max-term (length term)))
(setq max-what (max max-what (length what)))
(list nil
(vector
(list term
'name term
'path (racket-file-name-back-to-front path)
'anchor anchor
'action #'racket-describe-search-button)
what
from)))
vs))
(setq tabulated-list-sort-key nil)
(setq tabulated-list-format
Expand Down
95 changes: 53 additions & 42 deletions racket/scribble.rkt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@
(elisp-write term))
(newline))))

;; Newer exported-index-desc* struct introduced after Racket 8.14.
;; When available use new exported-index-desc* struct, introduced c.
;; Racket 8.14.0.5.
(define exported-index-desc*?
(dynamic-require 'scribble/manual-struct 'exported-index-desc*?
(λ () (λ (_) #f))))
Expand All @@ -154,68 +155,78 @@
(define xref (force xref-promise))
(define results
(for*/set ([entry (in-list (xref-index xref))]
[desc (in-value (entry-desc entry))]
#:when (not
(or (constructor-index-desc? desc)
(and (exported-index-desc*? desc)
(let ([ht (exported-index-desc*-extras desc)])
(for/or ([key (in-list
(list 'hidden?
'constructor?))])
(hash-ref ht key #f))))))
[term (in-value (car (entry-words entry)))]
#:when (string=? str term))
#:when (string=? str term)
[desc (in-value (entry-desc entry))]
#:when desc
[_ (in-value (println desc))] ;;; DEBUG
;;;[_ (in-value (println (entry-content entry)))] ;;; DEBUG
#:unless (or (constructor-index-desc? desc)
(and (exported-index-desc*? desc)
(let ([ht (exported-index-desc*-extras desc)])
(or (hash-ref ht 'hidden? #f)
(hash-ref ht 'constructor? #f))))))
(define tag (entry-tag entry))
(define (what/method tag)
(cond
[(method-tag? tag)
(define-values (c/i _m) (get-class/interface-and-method tag))
(format "method of ~a" c/i)]
[else "method"]))
(define-values (path anchor) (xref-tag->path+anchor xref tag))
(define-values (what from)
(cond
[(module-path-index-desc? desc)
(values 'module null)]
[(and (exported-index-desc*? desc)
(hash-ref (exported-index-desc*-extras desc) 'kind #f))
=>
(λ (kind)
(values kind
(exported-index-desc-from-libs desc)))]
[(exported-index-desc*? desc)
(define ht (exported-index-desc*-extras desc))
(define kind (hash-ref ht 'kind))
(define what (if (string=? kind "method")
(what/method tag)
kind))
(define libs (exported-index-desc-from-libs desc))
(values what libs)]
[(exported-index-desc? desc)
(define kind
(match desc
[(? language-index-desc?) 'language]
[(? reader-index-desc?) 'reader]
[(? form-index-desc?) 'syntax]
[(? procedure-index-desc?) 'procedure]
[(? thing-index-desc?) 'value]
[(? struct-index-desc?) 'structure]
[(? class-index-desc?) 'class]
[(? interface-index-desc?) 'interface]
[(? mixin-index-desc?) 'mixin]
[(? method-index-desc?)
(cond
[(method-tag? tag)
(define-values (c/i _m) (get-class/interface-and-method tag))
(cons 'method c/i)]
[else 'method])]
[(? language-index-desc?) "language"]
[(? reader-index-desc?) "reader"]
[(? form-index-desc?) "syntax"]
[(? procedure-index-desc?) "procedure"]
[(? thing-index-desc?) "value"]
[(? struct-index-desc?) "structure"]
[(? class-index-desc?) "class"]
[(? interface-index-desc?) "interface"]
[(? mixin-index-desc?) "mixin"]
[(? method-index-desc?) (what/method tag)]
[_ ""]))
(define libs (exported-index-desc-from-libs desc))
(values kind libs)]
[(module-path-index-desc? desc)
(values "module" null)]
[else
(values 'documentation
(list
(values (format "in ~a"
(match (reverse (explode-path path))
[(list* _ v _) (path->string v)]
[_ (~a tag)])))]))
(list term what from path anchor)))
[_ (~a tag)]))
null)]))
(define from-str (string-join (map ~s from) ", "))
(list term what from-str path anchor)))
(sort (set->list results)
string<?
#:cache-keys? #t
#:key
(match-lambda
[(list* _term _what (cons from _) _path _anchor)
(match (~a from)
[(list* _term _what from _path _anchor)
(match from
;; sort things from some distinguished libs first
[(and (pregexp "^racket/") v)
(string-append "0_" v)]
(string-append " 0_" v)]
[(and (pregexp "^typed/racket/") v)
(string-append "1_" v)]
(string-append " 1_" v)]
[(and (pregexp "^rhombus") v)
(string-append " 2_" v)]
;; not from any libs: sort last
[""
(make-string 128 #\z)]
[v v])]
[(cons term _) term]))))

Expand Down

0 comments on commit 186ad56

Please sign in to comment.