diff options
author | Neil Jerram <neil@ossau.uklinux.net> | 2001-11-16 09:55:54 +0000 |
---|---|---|
committer | Neil Jerram <neil@ossau.uklinux.net> | 2001-11-16 09:55:54 +0000 |
commit | cecb4a5e9dbaebcc28f3be0a02feac4263a2cfcc (patch) | |
tree | 786d449cb6dbfaa57724d24c85b67b8b073fddcb /scripts | |
parent | 73c844bf02487de732da88ec290a44029a8247d9 (diff) | |
download | guile-cecb4a5e9dbaebcc28f3be0a02feac4263a2cfcc.tar.gz |
* These changes add a @deffnx C function declaration and function
index entries for each Guile primitive to the copy of the doc
snarf output that is used for reference manual synchronization.
Online help is unchanged.
Diffstat (limited to 'scripts')
-rw-r--r-- | scripts/ChangeLog | 18 | ||||
-rwxr-xr-x | scripts/snarf-check-and-output-texi | 52 |
2 files changed, 62 insertions, 8 deletions
diff --git a/scripts/ChangeLog b/scripts/ChangeLog index 0aff09883..01dd7eb19 100644 --- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,21 @@ +2001-11-16 Neil Jerram <neil@ossau.uklinux.net> + + These changes add a @deffnx C function declaration and function + index entries for each Guile primitive to the copy of the doc + snarf output that is used for reference manual synchronization. + Online help is unchanged. + + * snarf-check-and-output-texi (*manual-flag*, + snarf-check-and-output-texi): Handle `--manual' invocation arg + passed through from libguile/Makefile.am. + (*c-function-name*, begin-multiline, do-command): Pick out C + function name from snarfed token stream. + (end-multiline): Add @deffnx C declaration and function index + entries to output. + (*primitive-deffnx-signature*, *primitive-deffnx-sig-length*): + Fluff to help insert the C declaration after any "@deffnx + primitive" lines in the snarfed docstring. + 2001-10-05 Thien-Thi Nguyen <ttn@glug.org> * read-scheme-source (quoted?, clump): New procs, exported. diff --git a/scripts/snarf-check-and-output-texi b/scripts/snarf-check-and-output-texi index a300ca78e..f6ca78757 100755 --- a/scripts/snarf-check-and-output-texi +++ b/scripts/snarf-check-and-output-texi @@ -39,7 +39,11 @@ exec ${GUILE-guile} -l $0 -c "(apply $main (cdr (command-line)))" "$@" (define-macro (unless cond . body) `(if (not ,cond) (begin ,@body))) -(define (snarf-check-and-output-texi) +(define *manual-flag* #f) + +(define (snarf-check-and-output-texi . flags) + (if (memq '--manual flags) + (set! *manual-flag* #t)) (process-stream (current-input-port))) (define (process-stream port) @@ -122,6 +126,7 @@ exec ${GUILE-guile} -l $0 -c "(apply $main (cdr (command-line)))" "$@" (define *file* #f) (define *line* #f) +(define *c-function-name* #f) (define *function-name* #f) (define *snarf-type* #f) (define *args* #f) @@ -131,12 +136,16 @@ exec ${GUILE-guile} -l $0 -c "(apply $main (cdr (command-line)))" "$@" (define (begin-multiline) (set! *file* #f) (set! *line* #f) + (set! *c-function-name* #f) (set! *function-name* #f) (set! *snarf-type* #f) (set! *args* #f) (set! *sig* #f) (set! *docstring* #f)) +(define *primitive-deffnx-signature* "@deffnx primitive ") +(define *primitive-deffnx-sig-length* (string-length *primitive-deffnx-signature*)) + (define (end-multiline) (let* ((req (car *sig*)) (opt (cadr *sig*)) @@ -170,16 +179,40 @@ exec ${GUILE-guile} -l $0 -c "(apply $main (cdr (command-line)))" "$@" (if (not (null? tail)) (begin (format #t "~A" (car tail)) - (loop-tail (cdr tail))))))))))))))) + (loop-tail (cdr tail)))))))))))))) + (scm-deffnx + (if (and *manual-flag* (eq? *snarf-type* 'primitive)) + (with-output-to-string + (lambda () + (format #t "@deffnx function SCM ~A (" *c-function-name*) + (unless (null? *args*) + (format #t "SCM ~A" (car *args*)) + (let loop ((args (cdr *args*))) + (unless (null? args) + (format #t ", SCM ~A" (car args)) + (loop (cdr args))))) + (format #t ")\n"))) + #f))) (format #t "\n~A\n" *function-name*) (format #t "@c snarfed from ~A:~A\n" *file* *line*) (format #t "@deffn primitive ~A\n" nice-sig) - (let loop ((strings *docstring*)) - (if (not (null? strings)) - (begin - (display (car strings)) - (loop (cdr strings))))) - (display "\n@end deffn\n")))) + (let loop ((strings *docstring*) (scm-deffnx scm-deffnx)) + (cond ((null? strings)) + ((or (not scm-deffnx) + (and (>= (string-length (car strings)) + *primitive-deffnx-sig-length*) + (string=? (substring (car strings) + 0 *primitive-deffnx-sig-length*) + *primitive-deffnx-signature*))) + (display (car strings)) + (loop (cdr strings) scm-deffnx)) + (else (display scm-deffnx) + (loop strings #f)))) + (display "\n") + (when *manual-flag* + (format #t "@findex ~A\n" *function-name*) + (format #t "@findex ~A\n" *c-function-name*)) + (display "@end deffn\n")))) (define (texi-quote s) (let rec ((i 0)) @@ -221,6 +254,9 @@ exec ${GUILE-guile} -l $0 -c "(apply $main (cdr (command-line)))" "$@" (define do-command (match-lambda + (('cname ('id . name)) + (set! *c-function-name* (texi-quote (symbol->string name)))) + (('fname ('string . name)) (set! *function-name* (texi-quote name))) |