Diff for /gforth/ds2texi.fs between versions 1.1 and 1.13

version 1.1, 1994/10/24 19:15:55 version 1.13, 1997/02/12 00:25:34
Line 1 Line 1
 \ documentation source to texi format converter  \ 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  \ 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 7 Line 25
 \ The glossary entries are generated from data present in the wordlist  \ The glossary entries are generated from data present in the wordlist
 \ `documentation'. Each word resides there under its own name.  \ `documentation'. Each word resides there under its own name.
   
   script? [IF]
       warnings off
       require extend.fs
       require search-order.fs
       require glocals.fs
       require float.fs
       require struct.fs
       require debugging.fs
   [THEN]
   
 wordlist constant documentation  wordlist constant documentation
   
 struct  struct
Line 17  struct Line 45  struct
     2 cells: field doc-description      2 cells: field doc-description
 end-struct doc-entry  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 -- )  : emittexi ( c -- )
     >r      >r
     s" @{}" r@ scan 0<>      s" @{}" r@ scan 0<>
Line 34  end-struct doc-entry Line 118  end-struct doc-entry
     drop ;      drop ;
   
 : print-short ( doc-entry -- )  : 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 ." }       "      ." @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 ." ''@end format" cr      r@ doc-pronounciation 2@ type ." ''" cr ." @end format" cr
     rdrop ;      rdrop ;
   
 : print-doc ( doc-entry -- )  : print-doc ( doc-entry -- )
Line 46  end-struct doc-entry Line 139  end-struct doc-entry
     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-3ex" cr ." @end iftex" cr
           type cr cr \ ." @ifinfo" cr ." @*" cr ." @end ifinfo" cr cr
     else      else
         2drop cr          2drop cr
     endif      endif
Line 92  create docline doclinelength chars allot Line 186  create docline doclinelength chars allot
         docline swap process-line          docline swap process-line
     repeat      repeat
     drop rdrop ;      drop rdrop ;
   
   : 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 ;

Removed from v.1.1  
changed lines
  Added in v.1.13


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