561 lines
23 KiB
Scheme
561 lines
23 KiB
Scheme
(module search mzscheme
|
|
(require (lib "string-constant.ss" "string-constants")
|
|
"docpos.ss"
|
|
"colldocs.ss"
|
|
"path.ss"
|
|
"manuals.ss"
|
|
(lib "list.ss")
|
|
(lib "plt-match.ss")
|
|
(lib "contract.ss"))
|
|
|
|
(provide doc-collections-changed)
|
|
(provide/contract
|
|
[do-search
|
|
(string?
|
|
number?
|
|
boolean?
|
|
boolean?
|
|
(listof path?)
|
|
boolean?
|
|
any/c
|
|
(-> any)
|
|
(string? any/c . -> . void?)
|
|
(string? any/c . -> . void?)
|
|
(string? string? string? path? (union string? number? false/c) any/c . -> . void?)
|
|
. -> .
|
|
(union string? false/c))]
|
|
|
|
(build-string-finds/finds (string?
|
|
boolean?
|
|
boolean?
|
|
. -> .
|
|
(values (listof string?)
|
|
(listof (union regexp? string?)))))
|
|
|
|
(non-regexp (string? . -> . string?)))
|
|
|
|
(define (html-doc-position x)
|
|
(or (user-defined-doc-position x)
|
|
(standard-html-doc-position x)))
|
|
|
|
; These are set by reset-doc-lists:
|
|
; docs, doc-names and doc-kinds are parallel lists. doc-kinds
|
|
; distinguishes between the two variants of docs.
|
|
; docs : (list-of (union string (list path string)))
|
|
(define docs null)
|
|
; doc-names : (list-of string)
|
|
(define doc-names null)
|
|
; doc-kinds : (list-of symbol)
|
|
(define doc-kinds null)
|
|
; doc-collection-date : (union #f number 'none)
|
|
(define doc-collection-date #f)
|
|
|
|
(define (reset-doc-lists)
|
|
; Locate standard HTML documentation
|
|
(define-values (std-docs std-doc-names)
|
|
(let* ([docs (find-doc-directories)]
|
|
[doc-names (map get-doc-name docs)])
|
|
; Order the standard docs:
|
|
(let ([ordered (quicksort
|
|
(map list docs doc-names)
|
|
(lambda (a b) ; html-doc-position expects collection name
|
|
(let-values ([(_1 a-short _2) (split-path (car a))]
|
|
[(_3 b-short _4) (split-path (car b))])
|
|
(< (html-doc-position a-short)
|
|
(html-doc-position b-short)))))])
|
|
(values (map car ordered) (map cadr ordered))))) ; here we want the std title
|
|
|
|
; Check collections for doc.txt files:
|
|
(define-values (txt-docs txt-doc-names) (colldocs))
|
|
|
|
(set! docs (append std-docs txt-docs))
|
|
|
|
(set! doc-names (append
|
|
std-doc-names
|
|
(map (lambda (s) (format "the ~a collection" s))
|
|
txt-doc-names)))
|
|
(set! doc-kinds (append (map (lambda (x) 'html) std-docs) (map (lambda (x) 'text) txt-docs)))
|
|
|
|
(with-handlers ([exn:fail:filesystem? (lambda (x) (set! doc-collection-date 'none))])
|
|
(set! doc-collection-date
|
|
(file-or-directory-modify-seconds
|
|
(collection-path "doc")))))
|
|
|
|
(define MAX-HIT-COUNT 300)
|
|
|
|
(define (clean-html s)
|
|
(regexp-replace*
|
|
"&[^;]*;"
|
|
(regexp-replace*
|
|
"<[^>]*>"
|
|
(regexp-replace*
|
|
"&"
|
|
(regexp-replace*
|
|
">"
|
|
(regexp-replace*
|
|
"<"
|
|
s
|
|
"<")
|
|
">")
|
|
"\\&")
|
|
"")
|
|
""))
|
|
|
|
(define (with-hash-table ht key compute)
|
|
(hash-table-get
|
|
ht
|
|
key
|
|
(lambda ()
|
|
(let ([v (compute)])
|
|
(hash-table-put! ht key v)
|
|
v))))
|
|
|
|
(define html-keywords (make-hash-table 'equal))
|
|
(define (load-html-keywords doc)
|
|
(with-hash-table
|
|
html-keywords
|
|
doc
|
|
(lambda ()
|
|
(transform-keywords
|
|
(build-path doc "keywords")))))
|
|
|
|
(define html-indices (make-hash-table 'equal))
|
|
(define (load-html-index doc)
|
|
(with-hash-table
|
|
html-indices
|
|
doc
|
|
(lambda ()
|
|
(transform-hdindex
|
|
(build-path doc "hdindex")))))
|
|
|
|
;; transform-hdindex : any -> (listof (list string path string string)
|
|
;; makes sure the input from the file is well-formed and changes
|
|
;; the bytes to paths.
|
|
(define (transform-hdindex filename)
|
|
(verify-file filename
|
|
(λ (l)
|
|
(match l
|
|
[`(,(? string? index)
|
|
,(? string? file)
|
|
,(? string? label)
|
|
,(? string? title))
|
|
#t]
|
|
[else
|
|
#f]))))
|
|
|
|
;; transform-keywords : any -> (listof (list string string path string string)
|
|
;; as with transform-hdindex
|
|
(define (transform-keywords filename)
|
|
(verify-file filename
|
|
(λ (l)
|
|
(match l
|
|
[`(,(? string? keyword)
|
|
,(? string? result)
|
|
,(? path-string? file)
|
|
,(? string? label)
|
|
,(? string? title))
|
|
#t]
|
|
[else
|
|
#f]))))
|
|
|
|
(define (verify-file filename ele-ok?)
|
|
(let/ec k
|
|
(let ([fail (lambda (why)
|
|
(fprintf (current-error-port)
|
|
"loading docs from ~a failed: ~a\n"
|
|
(path->string filename)
|
|
why)
|
|
(k '()))])
|
|
(with-handlers ([exn:fail:read? (lambda (x)
|
|
(fail
|
|
(format "read error when opening the file ~a"
|
|
(exn-message x))))]
|
|
[exn:fail:filesystem?
|
|
(lambda (x)
|
|
(fail (format
|
|
"filesystem error when opening the file ~a"
|
|
(exn-message x))))])
|
|
(let ([l (if (file-exists? filename)
|
|
(call-with-input-file filename read)
|
|
'())])
|
|
(unless (list? l) (fail "not a list"))
|
|
(for-each (lambda (l)
|
|
(unless (ele-ok? l)
|
|
(fail (format "line ~s is malformed" l))))
|
|
l)
|
|
l)))))
|
|
|
|
(define (parse-txt-file doc ht handle-one)
|
|
(with-hash-table
|
|
ht
|
|
doc
|
|
(lambda ()
|
|
(with-handlers ([exn:fail:filesystem? (lambda (x) null)])
|
|
(with-input-from-file doc
|
|
(lambda ()
|
|
(let loop ([start 0])
|
|
(let* ([r (read-line (current-input-port) 'any)]
|
|
[next (if (eof-object? r)
|
|
start
|
|
(+ start (string-length r) 1))])
|
|
(cond
|
|
[(eof-object? r) null]
|
|
[(handle-one r start) => (lambda (vs) (append vs (loop next)))]
|
|
[else (loop next)])))))))))
|
|
|
|
(define re:keyword-line (regexp "^>"))
|
|
(define text-keywords (make-hash-table 'equal))
|
|
(define (load-txt-keywords doc)
|
|
(parse-txt-file
|
|
(apply build-path doc)
|
|
text-keywords
|
|
(lambda (r start)
|
|
(cond
|
|
[(regexp-match re:keyword-line r)
|
|
(let/ec k
|
|
(let* ([p (open-input-string (substring r 1 (string-length r)))]
|
|
[entry (parameterize ([read-accept-bar-quote #f])
|
|
(with-handlers ([exn:fail:read?
|
|
(lambda (x)
|
|
(k null))])
|
|
(read p)))]
|
|
[key (let loop ([entry entry])
|
|
(cond
|
|
[(symbol? entry) entry]
|
|
[(pair? entry) (if (and (eq? (car entry) 'quote)
|
|
(pair? (cdr entry)))
|
|
(loop (cadr entry))
|
|
(loop (car entry)))]
|
|
[else (error "bad entry")]))]
|
|
[content (if (symbol? entry)
|
|
(with-handlers ([exn:fail:read? (lambda (x) #f)])
|
|
(let ([s (read p)])
|
|
(if (eq? s '::)
|
|
(read p)
|
|
#f)))
|
|
#f)])
|
|
(list
|
|
; Make the keyword entry:
|
|
(list (symbol->string key) ; the keyword name
|
|
(let ([p (open-output-string)])
|
|
(if content
|
|
(display content p)
|
|
(if (and (pair? entry)
|
|
(pair? (cdr entry))
|
|
(eq? (car entry) 'quote))
|
|
(fprintf p "'~s" (cadr entry))
|
|
(display entry p)))
|
|
(get-output-string p)) ; the text to display
|
|
(cadr doc) ; file
|
|
start ; label (a position in this case)
|
|
"doc.txt"))))] ; title
|
|
[else #f]))))
|
|
|
|
(define re:index-line (regexp "_([^_]*)_(.*)"))
|
|
(define text-indices (make-hash-table 'equal))
|
|
(define (load-txt-index doc)
|
|
(parse-txt-file
|
|
(apply build-path doc)
|
|
text-indices
|
|
(lambda (r start)
|
|
(cond
|
|
[(regexp-match re:index-line r)
|
|
=> (lambda (m)
|
|
(let loop ([m m])
|
|
(let ([s (cadr m)])
|
|
(cons
|
|
; Make an index entry:
|
|
(cons s start)
|
|
(let ([m (regexp-match re:index-line (caddr m))])
|
|
(if m
|
|
(loop m)
|
|
null))))))]
|
|
[else #f]))))
|
|
|
|
(define re:splitter (regexp "^ *([^ ]+)(.*)"))
|
|
(define (split-words s)
|
|
(let ([m (regexp-match re:splitter s)])
|
|
(if m
|
|
(cons (cadr m)
|
|
(split-words (caddr m)))
|
|
null)))
|
|
|
|
;; non-regexp : string -> string
|
|
(define (non-regexp s)
|
|
(list->string
|
|
(apply
|
|
append
|
|
(map
|
|
(lambda (c)
|
|
(cond
|
|
[(memq c '(#\$ #\| #\\ #\[ #\] #\. #\* #\? #\+ #\( #\) #\^))
|
|
(list #\\ c)]
|
|
[(char-alphabetic? c)
|
|
(list #\[ (char-upcase c) (char-downcase c) #\])]
|
|
[else (list c)]))
|
|
(string->list s)))))
|
|
|
|
(define (doc-collections-changed)
|
|
(set! doc-collection-date #f)
|
|
(set! html-keywords (make-hash-table 'equal))
|
|
(set! html-indices (make-hash-table 'equal))
|
|
(set! text-keywords (make-hash-table 'equal))
|
|
(set! text-indices (make-hash-table 'equal))
|
|
(reset-doc-positions!))
|
|
|
|
(define max-reached #f)
|
|
|
|
(define (build-string-finds/finds given-find regexp? exact?)
|
|
(cond
|
|
[exact? (values (list given-find)
|
|
(list given-find))]
|
|
[regexp? (values (list given-find)
|
|
(list (regexp given-find)))]
|
|
[else (let ([wl (split-words given-find)])
|
|
(values wl
|
|
(map regexp (map non-regexp wl))))]))
|
|
|
|
; do-search : (string ; the search text, unprocessed
|
|
; num ; 0 = keyword, 1 = keyword+index, 2 = all text
|
|
; boolean ; #t if string should be used as a regexp
|
|
; boolean ; #t if the string should match exactly (not just "contains")
|
|
; (listof path) ; the manuals to search
|
|
; boolean ; #t if the doc.txt files should be searched
|
|
; value ; arbitrary key supplied to the "add" functions
|
|
; (-> A) ; called when more than enough are found; must escape
|
|
; (string value -> void) ; called to output a document section header (e.g., a manual name)
|
|
; (symbol value -> void) ; called to output a document-kind section header, 'text or 'html
|
|
; (string string string path (union string #f) value -> void)
|
|
; ^ ^ ^ ^ ^- label within page
|
|
; ^ ^ ^ ^- path to doc page
|
|
; ^ ^ ^- source doc title
|
|
; ^ ^- display label
|
|
; ^- found entry's key
|
|
; ->
|
|
; (union string #f))
|
|
(define (do-search given-find search-level regexp? exact? manuals doc-txt?
|
|
ckey maxxed-out
|
|
add-doc-section add-kind-section add-choice)
|
|
; When new docs are installed, the directory's modification date changes:
|
|
(set! max-reached #f)
|
|
(unless (eq? doc-collection-date 'none)
|
|
(when (or (not doc-collection-date)
|
|
(> (file-or-directory-modify-seconds (collection-path "doc"))
|
|
doc-collection-date))
|
|
(reset-doc-lists)))
|
|
(let ([hit-count 0])
|
|
(let-values ([(string-finds finds) (build-string-finds/finds given-find regexp? exact?)]
|
|
[(filtered-docs filtered-doc-names filtered-doc-kinds)
|
|
(filter-docs manuals doc-txt?)])
|
|
(for-each
|
|
(lambda (doc doc-name doc-kind)
|
|
(define found-one #f)
|
|
(define (found kind)
|
|
(unless found-one
|
|
(add-doc-section doc-name ckey))
|
|
(unless (equal? found-one kind)
|
|
(set! found-one kind)
|
|
(add-kind-section kind ckey))
|
|
(set! hit-count (add1 hit-count))
|
|
(unless (< hit-count MAX-HIT-COUNT)
|
|
(maxxed-out)))
|
|
|
|
; Keyword search
|
|
(let ([keys (case doc-kind
|
|
[(html) (load-html-keywords doc)]
|
|
[(text) (load-txt-keywords doc)]
|
|
[else null])]
|
|
[add-key-choice (lambda (v)
|
|
(when (and (pair? v)
|
|
(pair? (cdr v))
|
|
(pair? (cddr v))
|
|
(pair? (cdddr v))
|
|
(pair? (cddddr v)))
|
|
(found "keyword entries")
|
|
(add-choice
|
|
(car v) ; key
|
|
(cadr v) ; display
|
|
(list-ref v 4) ; title
|
|
(if (eq? 'text doc-kind)
|
|
(apply build-path doc)
|
|
(let ([file (bytes->path
|
|
(string->bytes/utf-8
|
|
(list-ref v 2)))])
|
|
(if (servlet-path? file)
|
|
file
|
|
(build-path doc file))))
|
|
(list-ref v 3) ; label
|
|
ckey)))])
|
|
|
|
(unless regexp?
|
|
(for-each
|
|
(lambda (v)
|
|
(when (string=? given-find (car v))
|
|
(add-key-choice v)))
|
|
keys))
|
|
(unless (or exact? (null? finds))
|
|
(for-each
|
|
(lambda (v)
|
|
(when (andmap (lambda (find) (regexp-match find (car v))) finds)
|
|
(unless (and (not regexp?) (string=? given-find (car v)))
|
|
(add-key-choice v))))
|
|
keys)))
|
|
|
|
; Index search
|
|
(unless (< search-level 1)
|
|
(let ([index (case doc-kind
|
|
[(html) (load-html-index doc)]
|
|
[(text) (load-txt-index doc)]
|
|
[else null])]
|
|
[add-index-choice (lambda (name desc)
|
|
(case doc-kind
|
|
[(html)
|
|
(when (and (pair? desc)
|
|
(pair? (cdr desc))
|
|
(pair? (cddr desc)))
|
|
(found "index entries")
|
|
(add-choice
|
|
"" name
|
|
(list-ref desc 2)
|
|
(let ([filename (bytes->path (string->bytes/utf-8 (list-ref desc 0)))])
|
|
(if (servlet-path? filename)
|
|
filename
|
|
(build-path doc filename)))
|
|
(list-ref desc 1)
|
|
ckey))]
|
|
[(text)
|
|
(found "index entries")
|
|
(add-choice
|
|
"" name
|
|
"indexed content"
|
|
(apply build-path doc)
|
|
desc
|
|
ckey)]))])
|
|
(when index
|
|
(unless regexp?
|
|
(for-each
|
|
(lambda (v)
|
|
(when (string=? given-find (car v))
|
|
(add-index-choice (car v) (cdr v))))
|
|
index))
|
|
(unless (or exact? (null? finds))
|
|
(for-each
|
|
(lambda (v)
|
|
(when (andmap (lambda (find) (regexp-match find (car v))) finds)
|
|
(unless (and (not regexp?) (string=? given-find (car v)))
|
|
(add-index-choice (car v) (cdr v)))))
|
|
index)))))
|
|
|
|
; Content Search
|
|
(unless (or (< search-level 2) exact? (null? finds))
|
|
(let ([files (case doc-kind
|
|
[(html) (with-handlers ([exn:fail:filesystem? (lambda (x) null)])
|
|
(map (lambda (x) (build-path doc x))
|
|
(filter
|
|
(lambda (x) (file-exists? (build-path doc x)))
|
|
(directory-list doc))))]
|
|
[(text) (list (apply build-path doc))]
|
|
[else null])])
|
|
(for-each
|
|
(lambda (f)
|
|
(with-handlers ([exn:fail:filesystem? (lambda (x) #f)])
|
|
(with-input-from-file f
|
|
(lambda ()
|
|
(let loop ()
|
|
(let ([pos (file-position (current-input-port))]
|
|
[r (read-line)])
|
|
(unless (eof-object? r)
|
|
(let ([m (andmap (lambda (find) (regexp-match find r)) finds)])
|
|
(when m
|
|
(found "text")
|
|
(add-choice (car m)
|
|
; Strip leading space and clean HTML
|
|
(regexp-replace
|
|
"^ [ ]*"
|
|
(if (eq? doc-kind 'html)
|
|
(clean-html r)
|
|
r)
|
|
"")
|
|
"content"
|
|
f
|
|
(if (eq? doc-kind 'text) pos "NO TAG")
|
|
ckey)))
|
|
(loop))))))))
|
|
files))))
|
|
filtered-docs filtered-doc-names filtered-doc-kinds)
|
|
|
|
(if (= 0 hit-count)
|
|
(format (string-constant plt:hd:nothing-found-for)
|
|
(if (null? string-finds)
|
|
""
|
|
(apply
|
|
string-append
|
|
(cons (format "\"~a\"" (car string-finds))
|
|
(map (lambda (i) (format " ~a \"~a\"" (string-constant plt:hd:and) i))
|
|
(cdr string-finds))))))
|
|
#f))))
|
|
|
|
;; filter-docs : (listof path) boolean -> (values docs[sublist] doc-names[sublist] doc-kinds[sublist])
|
|
;; given the list of manuals specified by `manuals', returns the sublists of the global
|
|
;; variables docs, doc-names, and doc-kinds that make sense for this search.
|
|
(define (filter-docs manuals doc-txt?)
|
|
(let loop ([manuals manuals])
|
|
(cond
|
|
[(null? manuals) (if doc-txt?
|
|
(extract-doc-txt)
|
|
(values null null null))]
|
|
[else (let ([man (car manuals)])
|
|
(let-values ([(r-doc r-doc-names r-doc-kinds) (loop (cdr manuals))]
|
|
[(t-doc t-doc-names t-doc-kinds) (find-doc man)])
|
|
(if t-doc
|
|
(values (cons t-doc r-doc)
|
|
(cons t-doc-names r-doc-names)
|
|
(cons t-doc-kinds r-doc-kinds))
|
|
(values r-doc
|
|
r-doc-names
|
|
r-doc-kinds))))])))
|
|
|
|
;; find-doc :
|
|
;; path -> (values doc[element of docs] doc-name[element of doc-names] doc-kind[element of doc-kinds])
|
|
(define (find-doc man)
|
|
(let loop ([x-docs docs]
|
|
[x-doc-names doc-names]
|
|
[x-doc-kinds doc-kinds])
|
|
(cond
|
|
[(and (null? x-docs) (null? x-doc-names) (null? x-doc-kinds))
|
|
(values #f #f #f)]
|
|
[(or (null? x-docs) (null? x-doc-names) (null? x-doc-kinds))
|
|
(error 'find-doc "mismatched lists\n")]
|
|
[else
|
|
(let ([doc (car x-docs)])
|
|
(cond
|
|
[(eq? 'html (car x-doc-kinds))
|
|
(let-values ([(base name dir?) (split-path doc)])
|
|
(cond
|
|
[(equal? man name)
|
|
(values doc (car x-doc-names) (car x-doc-kinds))]
|
|
[else (loop (cdr x-docs) (cdr x-doc-names) (cdr x-doc-kinds))]))]
|
|
[else (loop (cdr x-docs) (cdr x-doc-names) (cdr x-doc-kinds))]))])))
|
|
|
|
;; extract-doc-txt : (listof string) boolean -> (values docs[sublist] doc-names[sublist] doc-kinds[sublist])
|
|
;; returns the manuals that are not 'html.
|
|
(define (extract-doc-txt)
|
|
(let loop ([x-docs docs]
|
|
[x-doc-names doc-names]
|
|
[x-doc-kinds doc-kinds])
|
|
(cond
|
|
[(null? x-docs) (values null null null)]
|
|
[(or (null? x-doc-names) (null? x-doc-kinds))
|
|
(error 'extract-doc-txt "mismatched lists\n")]
|
|
[else
|
|
(if (eq? (car x-doc-kinds) 'html)
|
|
(loop (cdr x-docs) (cdr x-doc-names) (cdr x-doc-kinds))
|
|
(let-values ([(r-docs r-doc-names r-doc-kinds) (loop (cdr x-docs)
|
|
(cdr x-doc-names)
|
|
(cdr x-doc-kinds))])
|
|
(values (cons (car x-docs) r-docs)
|
|
(cons (car x-doc-names) r-doc-names)
|
|
(cons (car x-doc-kinds) r-doc-kinds))))]))))
|
|
|
|
|