Diff for /gforth/ds2texi.fs between versions 1.6 and 1.33

version 1.6, 1995/09/15 14:52:49 version 1.33, 2008/02/25 16:41:06
Line 1 Line 1
 \ documentation source to texi format converter  \ documentation source to texi format converter
   
   \ Copyright (C) 1995,1996,1997,1998,1999,2003,2005,2007 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 3
   \ 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, see http://www.gnu.org/licenses/.
   
 \ documentation source can contain lines in the form `doc-word' and  \ documentation source can contain lines in the form `doc-word' and
 \ `short-word'. These are converted to appropriate full or short  \ `short-word'. These are converted to appropriate full or short
 \ (without the description) glossary entries for word.  \ (without the description) glossary entries for word.
Line 8 Line 25
 \ `documentation'. Each word resides there under its own name.  \ `documentation'. Each word resides there under its own name.
   
 script? [IF]  script? [IF]
 warnings off      warnings off
 include search-order.fs  
 include struct.fs  
 include debugging.fs  
 [THEN]  [THEN]
   
 wordlist constant documentation  wordlist constant documentation
   
 struct  struct
     2 cells: field doc-name      cell% 2* field doc-name
     2 cells: field doc-stack-effect      cell% 2* field doc-stack-effect
     2 cells: field doc-wordset      cell% 2* field doc-wordset
     2 cells: field doc-pronounciation      cell% 2* field doc-pronounciation
     2 cells: field doc-description      cell% 2* field doc-description
 end-struct doc-entry  end-struct doc-entry
   
 create description-buffer 4096 chars allot  create description-buffer 4096 chars allot
Line 39  create description-buffer 4096 chars all Line 53  create description-buffer 4096 chars all
     repeat then      repeat then
     description-buffer tuck - ;      description-buffer tuck - ;
   
   : skip-prefix ( c-addr1 u1 -- c-addr2 u2 )
       2dup s" --" string-prefix?
       IF
           [char] - skip [char] - scan 1 /string
       THEN ;
   
   : 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 ( -- )  : make-doc ( -- )
     get-current documentation set-current      get-current documentation set-current
     create      create
         last @ name>string 2,           \ name          latest name>string skip-prefix 2,               \ name
         [char] ) parse save-string 2,   \ stack-effect          [char] ) parse save-mem 2,      \ stack-effect
         bl parse-word save-string 2,    \ wordset          bl sword condition-wordset 2,   \ wordset
         bl parse-word dup               \ pronounciation          bl sword dup    \ pronounciation
         if          if
             save-string              condition-pronounciation
         else          else
             2drop last @ name>string              2drop latest name>string skip-prefix
         endif          endif
         2,          2,
         get-description save-string 2,          get-description save-mem 2,
     set-current ;      set-current ;
   
 : emittexi ( c -- )  : emittexi ( c -- )
Line 72  create description-buffer 4096 chars all Line 117  create description-buffer 4096 chars all
     drop ;      drop ;
   
 : print-short ( doc-entry -- )  : print-short ( doc-entry -- )
     >r ." @format" cr      >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
       r@ doc-name 2@ drop c@ [char] : <> if
           \ cut out words starting with :, info-lookup cannot handle them
           \ !! deal with : by replacing it here and in info-lookup?
           ." @kindex "
           r@ doc-name 2@ typetexi
           cr
       endif
       ." @format" cr
     ." @code{" r@ doc-name 2@ typetexi ." }       "      ." @code{" r@ doc-name 2@ typetexi ." }       "
     ." @i{" r@ doc-stack-effect 2@ type ." }       "      ." @i{" r@ doc-stack-effect 2@ type ." }       "
     r@ doc-wordset 2@ type ."        ``"      r@ doc-wordset 2@ type ."        ``"
     r@ doc-pronounciation 2@ type ." ''" cr ." @end format" cr      r@ doc-pronounciation 2@ type ." ''" cr ." @end format" cr
     ." @findex " r@ doc-name 2@ typetexi cr  
     rdrop ;      rdrop ;
   
 : print-doc ( doc-entry -- )  : print-doc ( doc-entry -- )
Line 85  create description-buffer 4096 chars all Line 145  create description-buffer 4096 chars all
     r@ print-short      r@ print-short
     r@ doc-description 2@ dup 0<>      r@ doc-description 2@ dup 0<>
     if      if
         type ." @*" cr          \ ." @iftex" cr ." @vskip-0ex" cr ." @end iftex" cr
           type cr cr
           \ ." @ifinfo" cr ." @*" cr ." @end ifinfo" cr cr
     else      else
         2drop cr          2drop cr
     endif      endif
Line 96  create description-buffer 4096 chars all Line 158  create description-buffer 4096 chars all
     \ with the prefix addr2 u2 and continuing with a word in the      \ with the prefix addr2 u2 and continuing with a word in the
     \ wordlist `documentation'. f is true if xt is executed.      \ wordlist `documentation'. f is true if xt is executed.
     >r dup >r      >r dup >r
     3 pick over compare 0=      3 pick over str=
     if \ addr2 u2 is a prefix of addr1 u1      if \ addr2 u2 is a prefix of addr1 u1
         r> /string documentation search-wordlist          r> /string -trailing documentation search-wordlist
         if \ the rest of addr1 u1 is in documentation          if \ the rest of addr1 u1 is in documentation
             execute r> execute true              execute r> execute true
         else          else
Line 132  create docline doclinelength chars allot Line 194  create docline doclinelength chars allot
     repeat      repeat
     drop rdrop ;      drop rdrop ;
   
 script? [IF]  : compare-ci ( addr1 u1 addr2 u2 -- n )
 include prims2x.fs      \ case insensitive string compare
 s" primitives.b" ' register-doc process-file      \ !! works correctly only for comparing for equality
 require doc.fd      2 pick swap -
 require crossdoc.fd      ?dup-0=-if
 s" gforth.ds" r/o open-file throw ds2texi bye          capscomp
 [THEN]      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 ;

Removed from v.1.6  
changed lines
  Added in v.1.33


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>