commit 43e59136128e10bca100aa9e9c298b7d40919dd4
parent cbd4e8ff8934e0613e8cc76e82afb3ffc7ab4dd6
Author: Eli Barzilay <eli@racket-lang.org>
Date: Thu, 7 Feb 2008 07:59:59 +0000
Lots of fixes & improvements for help
svn: r8561
original commit: 0cd1cc4b08276c41216c4b73895bfa1acb52eb59
Diffstat:
4 files changed, 168 insertions(+), 147 deletions(-)
diff --git a/collects/help/help.ss b/collects/help/help.ss
@@ -1,21 +1,31 @@
#lang scheme/base
-(require "search.ss"
- scheme/cmdline)
+(require "search.ss" scheme/cmdline)
-(define exact-search? #f)
+(define go-if-one? #t)
+(define exact-search? #f)
+(define regexp-search? #f)
(command-line
- #:once-any (["--exact" "-x"] "Go directly to the first exact hit for the search term" (set! exact-search? #t))
- #:args search-term
- (cond
- [exact-search?
- (when (null? search-term)
- (error 'plt-help "expected a search term after -x or --exact"))
- (unless (null? (cdr search-term))
- (error 'plt-help "expected a single search term, got ~s" search-term))
- (send-exact-results (car search-term))]
- [(null? search-term)
- (send-main-page)]
- [else
- (generate-search-results search-term)]))
+ #:once-any
+ [("--go" "-g") "Go directly to search result if only one (default)"
+ (set! go-if-one? #t)]
+ [("++go" "+g") "Show search results page even if only one result"
+ (set! go-if-one? #t)]
+ #:once-each
+ [("--exact" "-x") "Search for the given term exactly"
+ (set! exact-search? #t)]
+ [("--regexp" "-r") "Search for the given regexp"
+ (set! regexp-search? #t)]
+ #:args search-terms
+ (let ([one? (= 1 (length search-terms))])
+ (cond [(and regexp-search? (not one?))
+ (error 'plt-help "expected a single regexp after -r or --regexp")]
+ [(and exact-search? (not one?))
+ (error 'plt-help "expected a single search term after -x or --exact")]
+ [(null? search-terms) (send-main-page)]
+ [else (perform-search (if regexp-search?
+ (list (regexp (car search-terms)))
+ search-terms)
+ #:exact? (or exact-search? regexp-search?)
+ #:go-if-one? go-if-one?)])))
diff --git a/collects/help/search.ss b/collects/help/search.ss
@@ -12,10 +12,8 @@
mzlib/contract
setup/dirs)
-(provide/contract
- [generate-search-results (-> (listof string?) void?)]
- [send-exact-results (-> string? void?)]
- [send-main-page (-> void?)])
+(provide/contract [send-main-page (-> void?)])
+(provide perform-search)
(define (send-main-page)
(let* ([path (build-path (find-user-doc-dir) "index.html")]
@@ -23,53 +21,120 @@
path (build-path (find-doc-dir) "index.html"))])
(send-url/file path)))
-;; if there is exactly one exact match for this search key, go directly
-;; to that place. Otherwise, go to a page that lists all of the matches.
-(define (send-exact-results search-key)
- (let* ([file (next-search-results-file)]
- [exact-search-regexp (regexp (format "^~a$" (regexp-quote search-key #f)))]
- [x (load-collections-xref)]
- [index (xref-index x)]
- [len (length index)]
- [exact-matches (filter (has-match (list exact-search-regexp)) index)])
- (if (or (null? exact-matches)
- (not (null? (cdr exact-matches))))
- (generate-search-results (list search-key))
- (let ([match (car exact-matches)])
- (let-values ([(path tag) (xref-tag->path+anchor x (entry-tag match))])
- (send-url/file path #:fragment (uri-encode tag)))))))
+;; Configuration of search results
+(define maximum-entries 500)
+(define exact-score 1000)
+(define prefix-score 100)
+(define suffix-score 20)
+(define contain-score 10)
+(define regexp-score-factor 1.25) ; regexps get higher score
+(define nomatch-score -1) ; prefer less irrelevant terms
-(define (generate-search-results search-keys)
- (let ([file (next-search-results-file)]
- [search-regexps (map (λ (x) (regexp (regexp-quote x #f))) search-keys)]
- [exact-search-regexps
- (map (λ (x) (regexp (format "^~a$" (regexp-quote x #f)))) search-keys)]
- [search-key-string
- (if (null? search-keys)
- ""
- (apply string-append
- (car search-keys)
- (map (λ (x) (format ", or ~a" x)) (cdr search-keys))))])
- (let ([x (load-collections-xref)])
- (xref-render
- x
- (decode `(,(title (format "Search results for ~a" search-key-string))
- ,@(let* ([index (xref-index x)]
- [len (length index)]
- [matching-entries (filter (has-match search-regexps) index)]
- [exact-matches (filter (has-match exact-search-regexps) matching-entries)]
- [inexact-matches (filter (compose not (has-match exact-search-regexps)) matching-entries)])
- (cond
- [(and (null? exact-matches)
- (null? inexact-matches))
- (list (make-element "schemeerror" (list "No results found.")))]
- [else
- (append
- (build-itemization "Exact matches" exact-matches)
- (build-itemization "Containing matches" inexact-matches))]))))
- file)
- (send-url/file file)
- (void))))
+(define (perform-search terms #:exact? [exact? #f] #:go-if-one? [go-if-one? #t])
+ (if (null? terms)
+ (send-main-page)
+ (let* ([xref (load-collections-xref)]
+ [entries (xref-index xref)]
+ [scorer (terms->scorer terms exact?)]
+ [scored-entries
+ (let loop ([es entries] [r '()])
+ (if (null? es)
+ r
+ (loop (cdr es)
+ (let* ([e (car es)] [score (scorer e)])
+ (if (score . > . 0) (cons (cons score e) r) r)))))])
+ (if (and go-if-one? (= 1 (length scored-entries)))
+ (let*-values ([(tag) (entry-tag (cdar scored-entries))]
+ [(path tag) (xref-tag->path+anchor xref tag)])
+ (send-url/file path #:fragment (uri-encode tag)))
+ (let* ([file (next-search-results-file)]
+ [term->label
+ (λ (t) (format "``~a''" (if (regexp? t) (object-name t) t)))]
+ [search-title ; note: terms is not null at this point (see above)
+ (apply string-append (term->label (car terms))
+ (map (λ (x) (format ", ~a" (term->label x)))
+ (cdr terms)))]
+ [search-title (string-append "Search results for " search-title)]
+ [entries (map cdr (sort scored-entries scored-entry<?))]
+ [contents
+ (if (null? entries)
+ (list (make-element "schemeerror" (list "No results found.")))
+ (build-itemization entries))]
+ [contents (cons (title search-title) contents)])
+ (xref-render xref (decode contents) file)
+ (send-url/file file))))))
+
+;; converts a list of search terms to a scoring function
+(define (terms->scorer terms exact?)
+ (define scorers
+ (map (lambda (term)
+ (let* ([rx? (regexp? term)]
+ [rx (if rx? (object-name term) (regexp-quote term #f))]
+ ;; note: still works if we're given a regexp with ^/$ anchors
+ [exact (regexp (format "^~a$" rx))]
+ [prefix (regexp (format "^~a" rx))]
+ [suffix (regexp (format "~a$" rx))]
+ [contain (if rx? term (regexp rx))])
+ (lambda (str)
+ (let* ([sc (cond [(regexp-match? exact str) exact-score]
+ [exact? nomatch-score]
+ [(regexp-match? prefix str) prefix-score]
+ [(regexp-match? suffix str) suffix-score]
+ [(regexp-match? contain str) contain-score]
+ [else nomatch-score])]
+ [sc (if (and rx? (sc . > . 0))
+ (* sc regexp-score-factor)
+ sc)])
+ sc))))
+ terms))
+ (lambda (entry)
+ (foldl (lambda (word acc)
+ (+ acc (foldl (lambda (sc acc) (+ acc (sc word))) 0 scorers)))
+ 0 (entry-words entry))))
+
+(define (scored-entry<? x y)
+ (let ([xsc (car x)] [ysc (car y)])
+ (cond [(> xsc ysc) #t]
+ [(< xsc ysc) #f]
+ [else (let loop ([xs (entry-words (cdr x))]
+ [ys (entry-words (cdr y))])
+ (cond [(null? ys) #f]
+ [(null? xs) #t]
+ [(string-ci=? (car xs) (car ys))
+ (or (loop (cdr xs) (cdr ys))
+ ;; Try string<? so "Foo" still precedes "foo"
+ (string<? (car xs) (car ys)))]
+ [else (string-ci<? (car xs) (car xs))]))])))
+
+
+(define next-search-results-file
+ (let ([n -1] [tmp (find-system-path 'temp-dir)])
+ (lambda ()
+ (set! n (modulo (add1 n) 10))
+ (build-path tmp (format "search-results-~a.html" n)))))
+
+;; build-itemization : (nonempty-listof entry) -> (listof <stuff>)
+(define (build-itemization entries)
+ (define entries*
+ (if (<= (length entries) maximum-entries)
+ entries
+ (let loop ([n maximum-entries] [es entries] [r '()])
+ (if (or (null? es) (zero? n))
+ (reverse r)
+ (loop (sub1 n) (cdr es) (cons (car es) r))))))
+ (cons (apply itemize
+ (map (λ (entry)
+ (apply item
+ (make-link-element "indexlink"
+ (entry-content entry)
+ (entry-tag entry))
+ (make-extra-content (entry-desc entry))))
+ entries*))
+ (if (eq? entries* entries)
+ '()
+ (list (make-element "schemeerror"
+ (list (format "Search truncated after ~a hits."
+ maximum-entries)))))))
(define (make-extra-content desc)
;; Use `desc' to provide more details on the link:
@@ -92,58 +157,3 @@
(map (lambda (lib) (list ", " (scheme:to-element lib)))
(exported-index-desc-from-libs desc)))))
null)))
-
-(define next-search-results-file
- (let ([n -1] [tmp (find-system-path 'temp-dir)])
- (lambda ()
- (set! n (modulo (add1 n) 10))
- (build-path tmp (format "search-results-~a.html" n)))))
-
-;; has-match : (listof regexp) -> entry -> boolean
-(define ((has-match search-regexps) entry)
- (ormap (λ (str) (ormap (λ (key) (regexp-match key str)) search-regexps))
- (entry-words entry)))
-
-;; limit : exact-positive-integer
-;; maximum number of hits to display
-(define limit 500)
-
-;; build-itemization : (listof entry) -> (listof <stuff>)
-(define (build-itemization title entries)
- (if (null? entries)
- '()
- (let ([entries
- (sort
- entries
- (λ (x y) (string-ci<=? (entry->sort-key x) (entry->sort-key y))))])
- (list*
- (bold title)
- (apply itemize
- (map
- (λ (entry)
- (apply item
- (make-link-element
- "indexlink"
- (entry-content entry)
- (entry-tag entry))
- (make-extra-content
- (entry-desc entry))))
- (limit-length
- limit
- entries)))
- (if (<= (length entries) limit)
- '()
- (list (make-element "schemeerror"
- (list (format "Search truncated after ~a hits."
- limit)))))))))
-
-(define (limit-length n l)
- (cond [(null? l) '()]
- [(zero? n) '()]
- [else (cons (car l) (limit-length (- n 1) (cdr l)))]))
-
-(define (entry->sort-key e)
- (let ([words (entry-words e)])
- (apply string-append
- (car words)
- (map (λ (x) (string-append ", " x)) (cdr words)))))
diff --git a/collects/scribble/html-render.ss b/collects/scribble/html-render.ss
@@ -312,19 +312,22 @@
(part-parts (caar l)))
(cdr l))))]
[else (cons (car l) (loop (cdr l)))])))])
- (if (and #f (null? toc-content))
- null
- `((div ((class "tocview"))
- (div ((class "tocviewtitle"))
- (a ((href "index.html")
- (class "tocviewlink"))
- ,@(render-content (or (part-title-content top) '("???")) d ri)))
- (div nbsp)
- ,@(toc-wrap
- `(table
- ((class "tocviewlist")
- (cellspacing "0"))
- ,@toc-content))))))
+ (let* ([content (render-content
+ (or (part-title-content top) '("???"))
+ d ri)]
+ [content (if (null? toc-content)
+ content
+ `((a ((href "index.html")
+ (class "tocviewlink"))
+ ,@content)))])
+ `((div ((class "tocview"))
+ (div ((class "tocviewtitle")) ,@content)
+ (div nbsp)
+ ,@(if (null? toc-content)
+ '()
+ (toc-wrap
+ `(table ((class "tocviewlist") (cellspacing "0"))
+ ,@toc-content)))))))
,@(render-onthispage-contents d ri top)
,@(apply append
(map (lambda (t)
diff --git a/collects/scribble/xref.ss b/collects/scribble/xref.ss
@@ -22,7 +22,7 @@
(define-struct entry (words ; list of strings: main term, sub-term, etc.
content ; Scribble content to the index label
- tag ; for generating a Scribble link
+ tag ; for generating a Scribble link
desc)) ; further info that depends on the kind of index entry
;; Private:
@@ -63,11 +63,8 @@
(caddr v)))))))
(define (xref-render xrefs doc dest-file #:render% [render% (html:render-mixin render%)])
- (let* ([dest-file (if (string? dest-file)
- (string->path dest-file)
- dest-file)]
- [renderer (new render%
- [dest-dir (path-only dest-file)])]
+ (let* ([dest-file (if (string? dest-file) (string->path dest-file) dest-file)]
+ [renderer (new render% [dest-dir (path-only dest-file)])]
[ci (send renderer collect (list doc) (list dest-file))])
(send renderer transfer-info ci (resolve-info-ci (xrefs-ri xrefs)))
(let ([ri (send renderer resolve (list doc) (list dest-file) ci)])
@@ -121,15 +118,16 @@
(let-values ([(tag form?) (xref-binding-tag xrefs id/binding mode)])
tag))
-(define (xref-tag->path+anchor xrefs tag #:render% [render% (html:render-mixin render%)])
- (let ([renderer (new render%
- [dest-dir (find-system-path 'temp-dir)])])
- (send renderer tag->path+anchor (xrefs-ri xrefs) tag)))
+(define (xref-tag->path+anchor xrefs tag
+ #:render% [render% (html:render-mixin render%)])
+ (send (new render% [dest-dir (find-system-path 'temp-dir)])
+ tag->path+anchor (xrefs-ri xrefs) tag))
(define (xref-tag->index-entry xrefs tag)
- (let ([v (hash-table-get (collect-info-ext-ht (resolve-info-ci (xrefs-ri xrefs)))
- `(index-entry ,tag)
- #f)])
+ (let ([v (hash-table-get
+ (collect-info-ext-ht (resolve-info-ci (xrefs-ri xrefs)))
+ `(index-entry ,tag)
+ #f)])
(cond [v (make-entry (car v) (cadr v) (cadr tag) (caddr v))]
[(and (pair? tag) (eq? 'form (car tag)))
;; Try again with 'def:
