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
241
242
243
244
245
246
247
248
249
250
251
|
;; introspection.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 introspecting on scheme objects and their properties.
;;; Code:
(define-module (geiser introspection)
#:export (autodoc
completions
symbol-location
symbol-documentation
all-modules
module-children
module-location)
#:use-module (system vm program)
#:use-module (ice-9 regex)
#:use-module (ice-9 session)
#:use-module (ice-9 documentation)
#:use-module (srfi srfi-1))
(define (autodoc form)
(cond ((null? form) #f)
((symbol? form) (describe-application (list form)))
((list? form)
(let ((lst (last form)))
(cond ((symbol? lst) (or (describe-application (list lst))
(describe-application form)))
((list? lst)
(or (autodoc lst)
(autodoc (map (lambda (s) (if (list? s) (gensym) s)) form))))
(else (describe-application form)))))
(else #f)))
(define (describe-application form)
(let* ((fun (car form))
(args (obj-args (symbol->obj fun))))
(and args
(list (cons 'signature (signature fun args))
(cons 'position (find-position args form))
(cons 'module (symbol-module fun))))))
(define (signature fun args)
(let ((req (assq-ref args 'required))
(opt (assq-ref args 'optional))
(key (assq-ref args 'keyword))
(rest (assq-ref args 'rest)))
(let ((sgn `(,fun ,@(or req '())
,@(if opt (cons #:optional opt) '())
,@(if key (cons #:key key) '()))))
(if rest `(,@sgn . ,rest) sgn))))
(define (find-position args form)
(let* ((lf (length form))
(lf-1 (- lf 1)))
(if (= 1 lf) 0
(let ((req (length (or (assq-ref args 'required) '())))
(opt (length (or (assq-ref args 'optional) '())))
(keys (map (lambda (k) (symbol->keyword (if (list? k) (car k) k)))
(or (assq-ref 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 1 0))))))))
(define (symbol->obj sym)
(and (symbol? sym)
(module-defined? (current-module) sym)
(module-ref (current-module) sym)))
(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 (symbol-module sym)
(and sym
(call/cc
(lambda (k)
(apropos-fold (lambda (module name var init)
(if (eq? name sym) (k (module-name module)) init))
#f
(regexp-quote (symbol->string sym))
(apropos-fold-accessible (current-module)))))))
(define (gen-arg-names fst count)
(map (lambda (n) (string->symbol (format "arg-~A" (+ fst n))))
(iota (max count 1))))
(define (arguments proc)
"Return an alist describing the arguments that `proc' accepts, or `#f'
if the information cannot be obtained.
The alist keys that are currently defined are `required', `optional',
`keyword', and `rest'."
(cond
((procedure-property proc 'arglist)
=> (lambda (arglist)
`((required . ,(car arglist))
(optional . ,(cadr arglist))
(keyword . ,(caddr arglist))
(rest . ,(car (cddddr arglist))))))
((procedure-source proc)
=> (lambda (src)
(let ((formals (cadr src)))
(cond ((list? formals) `((required . ,formals)))
((pair? formals)
`((required . ,(car formals)) (rest . ,(cdr formals))))
(else #f)))))
(((@ (system vm program) program?) proc)
((@ (system vm program) program-arguments) proc))
((procedure-property proc 'arity)
=> (lambda (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)) '())))))
(else #f)))
(define (completions prefix)
(sort! (map symbol->string
(apropos-internal (string-append "^" prefix)))
string<?))
(define (module-location name)
(make-location (module-filename name) #f))
(define (symbol-location sym)
(cond ((symbol-module sym) => module-location)
(else '())))
(define (make-location file line)
(list (cons 'file (if (string? file) file '()))
(cons 'line (if (number? line) (+ 1 line) '()))))
(define module-filename (@@ (ice-9 session) module-filename))
(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))))
(define (symbol-documentation sym)
(let ((obj (symbol->obj sym)))
(if obj
`((signature . ,(or (obj-signature sym obj) sym))
(docstring . ,(docstring sym obj))))))
(define (all-modules)
(let ((roots ((@@ (ice-9 session) root-modules))))
(sort! (map (lambda (m)
(format "~A" (module-name m)))
(fold (lambda (m all)
(append (all-child-modules m) all))
roots
roots))
string<?)))
(define (child-modules mod)
(delq mod ((@@ (ice-9 session) submodules) mod)))
(define (all-child-modules mod)
(let ((children (child-modules mod)))
(fold (lambda (m all)
(append (all-child-modules m) all))
children children)))
(define (module-children mod-name)
(let* ((elts (hash-fold classify-module-object
(list '() '() '())
(module-obarray (maybe-module-interface mod-name))))
(elts (map sort-symbols! elts)))
(list (cons 'modules (map (lambda (m) `(,@mod-name ,m)) (car elts)))
(cons 'procs (cadr elts))
(cons 'vars (caddr elts)))))
(define (sort-symbols! syms)
(let ((cmp (lambda (l r)
(string<? (symbol->string l) (symbol->string r)))))
(sort! syms cmp)))
(define (maybe-module-interface mod-name)
(catch #t
(lambda () (resolve-interface mod-name))
(lambda args (resolve-module mod-name))))
(define (classify-module-object name var elts)
(let ((obj (and (variable-bound? var)
(variable-ref var))))
(cond ((not obj) elts)
((and (module? obj) (eq? (module-kind obj) 'directory))
(list (cons name (car elts))
(cadr elts)
(caddr elts)))
((or (procedure? obj) (program? obj) (macro? obj))
(list (car elts)
(cons name (cadr elts))
(caddr elts)))
(else (list (car elts)
(cadr elts)
(cons name (caddr elts)))))))
;;; introspection.scm ends here
|
