| \ documentation source to texi format converter |
\ documentation source to texi format converter |
| |
|
| \ Copyright (C) 1995 Free Software Foundation, Inc. |
\ Copyright (C) 1995,1996,1997,1998,1999,2003 Free Software Foundation, Inc. |
| |
|
| \ This file is part of Gforth. |
\ This file is part of Gforth. |
| |
|
| |
|
| \ You should have received a copy of the GNU General Public License |
\ You should have received a copy of the GNU General Public License |
| \ along with this program; if not, write to the Free Software |
\ along with this program; if not, write to the Free Software |
| \ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
\ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, 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 |
| |
|
| script? [IF] |
script? [IF] |
| warnings off |
warnings off |
| require search-order.fs |
require search.fs |
| |
require extend.fs |
| require glocals.fs |
require glocals.fs |
| require float.fs |
require float.fs |
| require struct.fs |
require struct.fs |
| require debugging.fs |
require debugs.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 |
| 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 -- ) |
: replace-_ ( c-addr u -- ) |
| \ replaces _ with - |
\ replaces _ with - |
| chars bounds |
chars bounds |
| : make-doc ( -- ) |
: make-doc ( -- ) |
| get-current documentation set-current |
get-current documentation set-current |
| create |
create |
| last @ name>string 2, \ name |
last @ name>string skip-prefix 2, \ name |
| [char] ) parse save-mem 2, \ stack-effect |
[char] ) parse save-mem 2, \ stack-effect |
| bl parse-word condition-wordset 2, \ wordset |
bl sword condition-wordset 2, \ wordset |
| bl parse-word dup \ pronounciation |
bl sword dup \ pronounciation |
| if |
if |
| condition-pronounciation |
condition-pronounciation |
| else |
else |
| 2drop last @ name>string |
2drop last @ name>string skip-prefix |
| endif |
endif |
| 2, |
2, |
| get-description save-mem 2, |
get-description save-mem 2, |
| ." @var{ " r@ doc-stack-effect 2@ type ." } " |
." @var{ " r@ doc-stack-effect 2@ type ." } " |
| r@ doc-wordset 2@ type |
r@ doc-wordset 2@ type |
| cr |
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 |
." @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@ print-short |
r@ print-short |
| r@ doc-description 2@ dup 0<> |
r@ doc-description 2@ dup 0<> |
| if |
if |
| ." @iftex" cr ." @vskip-3ex" cr ." @end iftex" cr |
\ ." @iftex" cr ." @vskip-0ex" cr ." @end iftex" cr |
| type cr cr \ ." @ifinfo" cr ." @*" cr ." @end ifinfo" cr cr |
type cr cr |
| |
\ ." @ifinfo" cr ." @*" cr ." @end ifinfo" cr cr |
| else |
else |
| 2drop cr |
2drop cr |
| endif |
endif |
| \ 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 documentation search-wordlist |
| if \ the rest of addr1 u1 is in documentation |
if \ the rest of addr1 u1 is in documentation |
| |
|
| : compare-ci ( addr1 u1 addr2 u2 -- n ) |
: compare-ci ( addr1 u1 addr2 u2 -- n ) |
| \ case insensitive string compare |
\ case insensitive string compare |
| |
\ !! works correctly only for comparing for equality |
| 2 pick swap - |
2 pick swap - |
| ?dup-0=-if |
?dup-0=-if |
| capscomp |
capscomp |
| else |
else |
| ." undocumented: " wordname type cr |
." undocumented: " wordname type cr |
| endif ; |
endif ; |
| |
|
| script? [IF] |
|
| require prims2x.fs |
|
| s" primitives.b" ' register-doc process-file |
|
| require crossdoc.fd |
|
| require doc.fd |
|
| [THEN] |
|
