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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
;; doc.scm -- name says it all
;; Copyright (C) 2009 Jose Antonio Ortega Ruiz
;; Author: Jose Antonio Ortega Ruiz <jao@gnu.org>
;; Start date: Sun Feb 08, 2009 18:44
;; This file 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 3 of the License, or
;; (at your option) any later version.
;; This file 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.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Comentary:
;; Procedures providing documentation on scheme objects.
;;; Code:
(define-module (geiser doc)
#:export (autodoc
symbol-documentation
object-signature)
#:use-module (geiser utils)
#:use-module (geiser modules)
#:use-module (system vm program)
#:use-module (ice-9 session)
#:use-module (ice-9 documentation)
#:use-module (ice-9 regex)
#:use-module (oop goops)
#:use-module (srfi srfi-1))
(define (autodoc form)
(cond ((null? form) #f)
((symbol? form) (describe-application (list form)))
((not (pair? form)) #f)
((not (list? form)) (autodoc (pair->list form)))
((define-head? form) => autodoc)
(else (autodoc/list form))))
(define (autodoc/list form)
(let ((lst (last form)))
(cond ((and (symbol? lst) (describe-application (list lst))))
((and (pair? lst) (not (memq (car lst) '(quote))) (autodoc lst)))
(else (describe-application form)))))
(define (define-head? form)
(define defforms '(define define* define-macro define-macro*
define-method define-class define-generic))
(and (= 2 (length form))
(memq (car form) defforms)
(car form)))
(define (describe-application form)
(let* ((fun (car form))
(args (obj-args (symbol->object fun))))
(and args
(list (cons 'signature (signature fun args))
(cons 'position (find-position args form))
(cons 'module (symbol-module fun))))))
(define (object-signature name obj)
(let ((args (obj-args obj)))
(and args (signature name args))))
(define (signature fun args)
(let ((req (arglst args 'required))
(opt (arglst args 'optional))
(key (arglst args 'keyword))
(rest (assq-ref args 'rest)))
(let ((sgn `(,fun ,@req
,@(if (not (null? opt)) (cons #:opt opt) '())
,@(if (not (null? key)) (cons #:key key) '()))))
(if rest `(,@sgn #:rest ,rest) sgn))))
(define (find-position args form)
(let* ((lf (length form))
(lf-1 (- lf 1)))
(if (= 1 lf) 0
(let ((req (length (arglst args 'required)))
(opt (length (arglst args 'optional)))
(keys (map (lambda (k) (symbol->keyword (if (list? k) (car k) k)))
(arglst args 'keyword)))
(rest (assq-ref args 'rest)))
(cond ((<= lf (+ 1 req)) lf-1)
((<= lf (+ 1 req opt)) (if (> opt 0) lf lf-1))
((or (memq (last form) keys)
(memq (car (take-right form 2)) keys)) =>
(lambda (sl)
(+ 2 req
(if (> opt 0) (+ 1 opt) 0)
(- (length keys) (length sl)))))
(else (+ 1 req
(if (> opt 0) (+ 1 opt) 0)
(if (null? keys) 0 (+ 1 (length keys)))
(if rest 2 0))))))))
(define (arglst args kind)
(let ((args (assq-ref args kind)))
(cond ((or (not args) (null? args)) '())
((list? args) args)
(else (list args)))))
(define (obj-args obj)
(cond ((not obj) #f)
((or (procedure? obj) (program? obj)) (arguments obj))
((macro? obj) (or (obj-args (macro-transformer obj))
'((required ...))))
(else #f)))
(define (arguments proc)
(cond
((is-a? proc <generic>) (generic-args proc))
((procedure-property proc 'arglist) => arglist->args)
((procedure-source proc) => source->args)
((program? proc) ((@ (system vm program) program-arguments) proc))
((doc->args proc))
((procedure-property proc 'arity) => arity->args)
(else #f)))
(define (source->args src)
(let ((formals (cadr src)))
(cond ((list? formals) `((required . ,formals)))
((pair? formals)
`((required . ,(car formals)) (rest . ,(cdr formals))))
(else #f))))
(define (arity->args art)
(let ((req (car art))
(opt (cadr art))
(rest (caddr art)))
`(,@(if (> req 0) (list (cons 'required (gen-arg-names 1 req))) '())
,@(if (> opt 0) (list (cons 'optional (gen-arg-names (+ 1 req) opt))) '())
,@(if rest (list (cons 'rest 'rest)) '()))))
(define (gen-arg-names fst count)
(let* ((letts (list->vector '(#\x #\y #\z #\u #\v #\w #\t)))
(len (vector-length letts))
(lett (lambda (n) (vector-ref letts (modulo n len)))))
(map (lambda (n) (string->symbol (format "~A" (lett (- n 1)))))
(iota (max count 1) fst))))
(define (arglist->args arglist)
`((required . ,(car arglist))
(optional . ,(cadr arglist))
(keyword . ,(caddr arglist))
(rest . ,(car (cddddr arglist)))))
(define (doc->args proc)
(define proc-rx "-- Scheme Procedure: ([^[\n]+)\n")
(define proc-rx2 "-- Scheme Procedure: ([^[\n]+\\[[^\n]*(\n[^\n]+\\]+)?)")
(cond ((procedure-property proc 'geiser-document-args))
((object-documentation proc)
=> (lambda (doc)
(let* ((match (or (string-match proc-rx doc)
(string-match proc-rx2 doc)))
(args (and match
(parse-signature-string (match:substring match 1)))))
(set-procedure-property! proc 'geiser-document-args args)
args)))
(else #f)))
(define (parse-signature-string str)
(define opt-arg-rx "\\[([^] ]+)\\]?")
(define opt-arg-rx2 "([^ ])+\\]+")
(let ((tokens (string-tokenize str)))
(if (< (length tokens) 2)
'()
(let loop ((tokens (cdr tokens)) (req '()) (opt '()) (rest #f))
(cond ((null? tokens)
`((required ,@(map string->symbol (reverse! req)))
(optional ,@(map string->symbol (reverse! opt)))
,@(if rest
(list (cons 'rest (string->symbol rest)))
'())))
((string=? "." (car tokens))
(if (not (null? (cdr tokens)))
(loop (cddr tokens) req opt (cadr tokens))
(loop '() req opt "rest")))
((or (string-match opt-arg-rx (car tokens))
(string-match opt-arg-rx2 (car tokens)))
=> (lambda (m)
(loop (cdr tokens)
req
(cons (match:substring m 1) opt)
rest)))
(else (loop (cdr tokens) (cons (car tokens) req) opt rest)))))))
(define (generic-args gen)
(define (src> src1 src2)
(> (length (cadr src1)) (length (cadr src2))))
(define (src m)
(catch #t
(lambda () (method-source m))
(lambda (k . a) #f)))
(let* ((methods (generic-function-methods gen))
(srcs (filter identity (map src methods))))
(cond ((and (null? srcs) (null? methods)) '((rest . rest)))
((and (null? srcs)
(not (null? methods))
(method-procedure (car methods)))
=> arguments)
((not (null? srcs)) (source->args (car (sort! srcs src>))))
(else '((rest . rest))))))
(define (symbol-documentation sym)
(let ((obj (symbol->object sym)))
(if obj
`((signature . ,(or (obj-signature sym obj) sym))
(docstring . ,(docstring sym obj))))))
(define (docstring sym obj)
(with-output-to-string
(lambda ()
(let* ((type (cond ((macro? obj) "A macro")
((procedure? obj) "A procedure")
((program? obj) "A compiled program")
(else "An object")))
(modname (symbol-module sym))
(doc (object-documentation obj)))
(display type)
(if modname
(begin
(display " in module ")
(display modname)))
(newline)
(if doc (display doc))))))
(define (obj-signature sym obj)
(let ((args (obj-args obj)))
(and args (signature sym args))))
;;; doc.scm ends here
|
