--- gforth/ds2texi.fs 1994/11/17 15:53:09 1.2 +++ gforth/ds2texi.fs 1997/02/01 14:59:28 1.12 @@ -1,5 +1,23 @@ \ documentation source to texi format converter +\ Copyright (C) 1995 Free Software Foundation, Inc. + +\ This file is part of Gforth. + +\ Gforth 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 2 +\ of the License, or (at your option) any later version. + +\ This program 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, write to the Free Software +\ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + \ documentation source can contain lines in the form `doc-word' and \ `short-word'. These are converted to appropriate full or short \ (without the description) glossary entries for word. @@ -9,9 +27,11 @@ script? [IF] warnings off -include search-order.fs -include struct.fs -include debugging.fs +require search-order.fs +require glocals.fs +require float.fs +require struct.fs +require debugging.fs [THEN] wordlist constant documentation @@ -24,6 +44,62 @@ struct 2 cells: field doc-description end-struct doc-entry +create description-buffer 4096 chars allot + +: get-description ( -- addr u ) + description-buffer + begin + refill + while + source nip + while + source swap >r 2dup r> -rot cmove + chars + + #lf over c! char+ + repeat then + description-buffer tuck - ; + +: replace-_ ( c-addr u -- ) + \ replaces _ with - + chars bounds + +DO + i c@ [char] _ = + if + [char] - i c! + endif + 1 chars + +loop ; + +: condition-stack-effect ( c-addr1 u1 -- c-addr2 u2 ) + save-mem 2dup replace-_ ; + +: condition-wordset ( c-addr1 u1 -- c-addr2 u2 ) + dup 0= + if + 2drop s" unknown" + else + save-mem + endif ; + +: condition-pronounciation ( c-addr1 u1 -- c-addr2 u2 ) + save-mem 2dup replace-_ ; + +: make-doc ( -- ) + get-current documentation set-current + create + last @ name>string 2, \ name + [char] ) parse save-mem 2, \ stack-effect + bl parse-word condition-wordset 2, \ wordset + bl parse-word dup \ pronounciation + if + condition-pronounciation + else + 2drop last @ name>string + endif + 2, + get-description save-mem 2, + set-current ; + : emittexi ( c -- ) >r s" @{}" r@ scan 0<> @@ -41,11 +117,20 @@ end-struct doc-entry drop ; : print-short ( doc-entry -- ) - >r ." @format" + >r + ." @findex " + r@ doc-name 2@ typetexi + ." @var{ " r@ doc-stack-effect 2@ type ." } " + r@ doc-wordset 2@ type + cr + ." @cindex " + ." @code{" r@ doc-name 2@ typetexi ." }" + cr + ." @format" cr ." @code{" r@ doc-name 2@ typetexi ." } " ." @i{" r@ doc-stack-effect 2@ type ." } " r@ doc-wordset 2@ type ." ``" - r@ doc-pronounciation 2@ type ." ''@end format" cr + r@ doc-pronounciation 2@ type ." ''" cr ." @end format" cr rdrop ; : print-doc ( doc-entry -- ) @@ -53,7 +138,8 @@ end-struct doc-entry r@ print-short r@ doc-description 2@ dup 0<> if - type ." @*" cr + ." @iftex" cr ." @vskip-3ex" cr ." @end iftex" cr + type cr cr \ ." @ifinfo" cr ." @*" cr ." @end ifinfo" cr cr else 2drop cr endif @@ -100,8 +186,37 @@ create docline doclinelength chars allot repeat drop rdrop ; -script? [IF] -include prims2x.fs -s" primitives.b" ' register-doc process-file -s" gforth.ds" r/o open-file throw ds2texi bye -[THEN] +: compare-ci ( addr1 u1 addr2 u2 -- n ) + \ case insensitive string compare + 2 pick swap - + ?dup-0=-if + capscomp + else + nip nip nip + 0< + if + -1 + else + 1 + endif + endif ; + +: answord ( "name wordset pronounciation" -- ) + \ check the documentaion of an ans word + name { D: wordname } + name { D: wordset } + name { D: pronounciation } + wordname documentation search-wordlist + if + execute { doc } + wordset doc doc-wordset 2@ compare-ci + if + ." wordset: " wordname type ." : '" doc doc-wordset 2@ type ." ' instead of '" wordset type ." '" cr + endif + pronounciation doc doc-pronounciation 2@ compare-ci + if + ." pronounciation: " wordname type ." : '" doc doc-pronounciation 2@ type ." ' instead of '" pronounciation type ." '" cr + endif + else + ." undocumented: " wordname type cr + endif ;