From 75df3b13501f2ccfc9ec8c7408795e5e8d5d067e Mon Sep 17 00:00:00 2001 From: Jose Antonio Ortega Ruiz Date: Tue, 17 Feb 2009 01:31:26 +0100 Subject: Better symbol documentation. --- geiser/emacs.scm | 2 +- geiser/introspection.scm | 54 ++++++++++++++++++++++++------------------------ 2 files changed, 28 insertions(+), 28 deletions(-) (limited to 'geiser') diff --git a/geiser/emacs.scm b/geiser/emacs.scm index b5ba284..36428f9 100644 --- a/geiser/emacs.scm +++ b/geiser/emacs.scm @@ -30,7 +30,7 @@ ge:symbol-location ge:compile-file ge:load-file - ge:docstring + ge:symbol-documentation ge:all-modules ge:module-children ge:module-location) diff --git a/geiser/introspection.scm b/geiser/introspection.scm index 2021a32..5d86d62 100644 --- a/geiser/introspection.scm +++ b/geiser/introspection.scm @@ -28,7 +28,7 @@ #:export (arguments completions symbol-location - docstring + symbol-documentation all-modules module-children module-location) @@ -128,34 +128,34 @@ (define module-filename (@@ (ice-9 session) module-filename)) -(define (display-docstring sym) +(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)) + (req (and args (car args))) + (opt (and args (cadr args)))) + (and args (if (not opt) `(,sym ,@req) `(,sym ,@req . ,opt)) sym))) + +(define (symbol-documentation sym) (let ((obj (symbol->obj sym))) (if obj - (let* ((args (obj-args obj)) - (req (and args (car args))) - (opt (and args (cadr args))) - (signature (if args - (if (not opt) `(,sym ,@req) `(,sym ,@req . ,opt)) - sym)) - (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 signature) - (newline) - (display type) - (if modname - (begin - (display " in module ") - (display modname))) - (newline) - (if doc (display doc)))))) - -(define (docstring sym) - (with-output-to-string - (lambda () (display-docstring sym)))) + `((signature . ,(or (obj-signature sym obj) sym)) + (docstring . ,(docstring sym obj)))))) (define (all-modules) (let ((roots ((@@ (ice-9 session) root-modules)))) -- cgit v1.2.3