chibi-scheme/tools/chibi-doc

91 lines
2.9 KiB
Text
Executable file

#! /usr/bin/env chibi-scheme
(import (chibi)
(only (meta) load-module)
(scheme file)
(scheme process-context)
(chibi string)
(chibi scribble)
(chibi doc)
(chibi sxml))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(define (write-to-string x)
(call-with-output-string (lambda (out) (write x out))))
;; print an error and exit without a stack trace
(define (die . args)
(for-each display args)
(newline)
(exit 1))
;; convert directly from scribble to the output format
(define (convert-scribble render in)
((or render sxml-display-as-html)
(generate-docs (scribble-parse in))))
;; convert from a module to the output format
(define (convert-module render mod-name mod . o)
((or render sxml-display-as-html)
(generate-docs
`((title ,(write-to-string mod-name))
,@(apply extract-module-docs mod-name mod #f o))
(make-module-doc-env mod-name))))
(define (convert-module-var render mod-name mod var)
((or render sxml-display-as-text)
(generate-docs
(extract-module-docs mod-name mod #t (list var))
(make-module-doc-env mod-name))))
;; utility to convert from "foo.bar" to (foo bar)
(define (split-module-name str)
(map (lambda (x) (or (string->number x) (string->symbol x)))
(string-split str #\.)))
;; main
(define (run args render)
(case (length args)
((0)
(convert-scribble render (current-input-port)))
((1)
(let ((name (car args)))
(cond
((equal? "-" name)
(convert-scribble render (current-input-port)))
((file-exists? name)
(call-with-input-file name
(lambda (in) (convert-scribble render in))))
(else
;; load the module so that examples work
(let* ((mod-name (split-module-name name))
(mod (load-module mod-name)))
(if mod
(convert-module render mod-name mod)
(die "ERROR: couldn't find file or module: " name)))))))
((2)
(let* ((name (car args))
(var (cadr args))
(mod-name (split-module-name name))
(mod (load-module mod-name)))
(if mod
(convert-module-var render mod-name mod (string->symbol var))
(die "ERROR: couldn't find module: " name))))
(else
(die "usage: chibi-doc [<scribble-file> | <module-name> [<var>]]"))))
;; parse the command-line
(let lp ((args (cdr (command-line)))
(render #f))
(cond
((and (pair? args) (not (equal? "" (car args)))
(eqv? #\- (string-ref (car args) 0)))
(case (string->symbol (substring (car args) 1))
((h -html) (lp (cdr args) sxml-display-as-html))
((s -sxml) (lp (cdr args) write))
((t -text) (lp (cdr args) sxml-display-as-text))
((-) (run (cdr args) render))
(else (die "unknown option: " (car args)))))
(else
(run args render))))