File size: 7,643 Bytes
3dcad1f |
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 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
;;; documentation.scm --- Run-time documentation facility
;;; Copyright (C) 2000-2003,2006,2009,2010,2024 Free Software Foundation, Inc.
;;;
;;; This library is free software: you can redistribute it and/or modify
;;; it under the terms of the GNU Lesser General Public License as
;;; published by the Free Software Foundation, either version 3 of the
;;; License, or (at your option) any later version.
;;;
;;; This library 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
;;; Lesser General Public License for more details.
;;;
;;; You should have received a copy of the GNU Lesser General Public
;;; License along with this program. If not, see
;;; <http://www.gnu.org/licenses/>.
;;; Commentary:
;;; * This module exports:
;;;
;;; file-commentary -- a procedure that returns a file's "commentary"
;;;
;;; documentation-files -- a search-list of files using the Guile
;;; Documentation Format Version 2.
;;;
;;; search-documentation-files -- a procedure that takes NAME (a symbol)
;;; and searches `documentation-files' for
;;; associated documentation. optional
;;; arg FILES is a list of filenames to use
;;; instead of `documentation-files'.
;;;
;;; object-documentation -- a procedure that returns its arg's docstring
;;;
;;; * Guile Documentation Format
;;;
;;; Here is the complete and authoritative documentation for the Guile
;;; Documentation Format Version 2:
;;;
;;; HEADER
;;; ^LPROC1
;;; DOCUMENTATION1
;;;
;;; ^LPROC2
;;; DOCUMENTATION2
;;;
;;; ^L...
;;;
;;; The HEADER is completely ignored. The "^L" are formfeeds. PROC1, PROC2
;;; and so on are symbols that name the element documented. DOCUMENTATION1,
;;; DOCUMENTATION2 and so on are the related documentation, w/o any further
;;; formatting. Note that there are two newlines before the next formfeed;
;;; these are discarded when the documentation is read in.
;;;
;;; (Version 1, corresponding to guile-1.4 and prior, is documented as being
;;; not documented anywhere except by this embarrassingly circular comment.)
;;;
;;; * File Commentary
;;;
;;; A file's commentary is the body of text found between comments
;;; ;;; Commentary:
;;; and
;;; ;;; Code:
;;; both of which must be at the beginning of the line. In the result string,
;;; semicolons at the beginning of each line are discarded.
;;;
;;; You can specify to `file-commentary' alternate begin and end strings, and
;;; scrub procedure. Use #t to get default values. For example:
;;;
;;; (file-commentary "documentation.scm")
;;; You should see this text!
;;;
;;; (file-commentary "documentation.scm" "^;;; Code:" "ends here$")
;;; You should see the rest of this file.
;;;
;;; (file-commentary "documentation.scm" #t #t string-upcase)
;;; You should see this text very loudly (note semicolons untouched).
;;; Code:
(define-module (ice-9 documentation)
#:use-module (ice-9 rdelim)
#:use-module (ice-9 regex)
#:use-module (ice-9 match)
#:export (file-commentary
documentation-files search-documentation-files
object-documentation))
;;
;; commentary extraction
;;
(define (file-commentary filename . cust) ; (IN-LINE-RE AFTER-LINE-RE SCRUB)
;; These are constants but are not at the top level because the repl in
;; boot-9.scm loads session.scm which in turn loads this file, and we want
;; that to work even even when regexps are not available (ie. make-regexp
;; doesn't exist), as for instance is the case on mingw.
;;
(define default-in-line-re (make-regexp "^;;; Commentary:"))
(define default-after-line-re (make-regexp "^;;; Code:"))
(define default-scrub (let ((dirt (make-regexp "^;+")))
(lambda (line)
(let ((m (regexp-exec dirt line)))
(if m (match:suffix m) line)))))
;; fixme: might be cleaner to use optargs here...
(let ((in-line-re (if (> 1 (length cust))
default-in-line-re
(let ((v (car cust)))
(cond ((regexp? v) v)
((string? v) (make-regexp v))
(else default-in-line-re)))))
(after-line-re (if (> 2 (length cust))
default-after-line-re
(let ((v (cadr cust)))
(cond ((regexp? v) v)
((string? v) (make-regexp v))
(else default-after-line-re)))))
(scrub (if (> 3 (length cust))
default-scrub
(let ((v (caddr cust)))
(cond ((procedure? v) v)
(else default-scrub))))))
(call-with-input-file filename
(lambda (port)
(let loop ((line (read-delimited "\n" port))
(doc "")
(parse-state 'before))
(if (or (eof-object? line) (eq? 'after parse-state))
doc
(let ((new-state
(cond ((regexp-exec in-line-re line) 'in)
((regexp-exec after-line-re line) 'after)
(else parse-state))))
(if (eq? 'after new-state)
doc
(loop (read-delimited "\n" port)
(if (and (eq? 'in new-state) (eq? 'in parse-state))
(string-append doc (scrub line) "\n")
doc)
new-state)))))))))
(define (parse-path var)
(match (getenv var)
(#f #f)
;; Ignore e.g. "export GUILE_SYSTEM_EXTENSIONS_PATH=".
("" '())
(val (string-split val #\:))))
;;
;; documentation-files is the list of places to look for documentation
;;
(define documentation-files
(map (lambda (vicinity)
(in-vicinity vicinity "guile-procedures.txt"))
(or (parse-path "GUILE_DOCSTRINGS_PATH")
(list (%library-dir) (%package-data-dir) (%site-dir)))))
(define entry-delimiter "\f")
(define (find-documentation-in-file name file)
(and (file-exists? file)
(call-with-input-file file
(lambda (port)
(let ((name (symbol->string name)))
(let ((len (string-length name)))
(read-delimited entry-delimiter port) ;skip to first entry
(let loop ((entry (read-delimited entry-delimiter port)))
(cond ((eof-object? entry) #f)
;; match?
((and ;; large enough?
(>= (string-length entry) len)
;; matching name?
(string=? (substring entry 0 len) name)
;; terminated?
(memq (string-ref entry len) '(#\newline)))
;; cut away name tag and extra surrounding newlines
(substring entry (+ len 2) (- (string-length entry) 2)))
(else (loop (read-delimited entry-delimiter port)))))))))))
(define (search-documentation-files name . files)
(or-map (lambda (file)
(find-documentation-in-file name file))
(cond ((null? files) documentation-files)
(else files))))
(define (object-documentation object)
"Return the docstring for OBJECT.
OBJECT can be a procedure, macro or any object that has its
`documentation' property set."
(or (and (procedure? object)
(procedure-documentation object))
(object-property object 'documentation)
(and (macro? object)
(object-documentation (macro-transformer object)))
(and (procedure? object)
(procedure-name object)
(let ((docstring (search-documentation-files
(procedure-name object))))
(if docstring
(set-procedure-property! object 'documentation docstring))
docstring))))
;;; documentation.scm ends here
|