version 1.8, 1995/10/16 18:33:06
|
version 1.34, 2008/07/15 16:11:49
|
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,2008 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 |
require search-order.fs |
|
require glocals.fs |
|
require float.fs |
|
require struct.fs |
|
require 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 41 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 -- ) |
: replace-_ ( c-addr u -- ) |
\ replaces _ with - |
\ replaces _ with - |
chars bounds |
chars bounds |
Line 53 create description-buffer 4096 chars all
|
Line 71 create description-buffer 4096 chars all
|
+loop ; |
+loop ; |
|
|
: condition-stack-effect ( c-addr1 u1 -- c-addr2 u2 ) |
: condition-stack-effect ( c-addr1 u1 -- c-addr2 u2 ) |
save-string 2dup replace-_ ; |
save-mem 2dup replace-_ ; |
|
|
: condition-wordset ( c-addr1 u1 -- c-addr2 u2 ) |
: condition-wordset ( c-addr1 u1 -- c-addr2 u2 ) |
dup 0= |
dup 0= |
if |
if |
2drop s" unknown" |
2drop s" unknown" |
else |
else |
save-string |
save-mem |
endif ; |
endif ; |
|
|
: condition-pronounciation ( c-addr1 u1 -- c-addr2 u2 ) |
: condition-pronounciation ( c-addr1 u1 -- c-addr2 u2 ) |
save-string 2dup replace-_ ; |
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 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 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 105 create description-buffer 4096 chars all
|
Line 123 create description-buffer 4096 chars all
|
." @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 ." } " |
Line 117 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 |
." @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 |
Line 129 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 167 create docline doclinelength chars allot
|
Line 196 create docline doclinelength chars allot
|
|
|
: 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 |
Line 199 create docline doclinelength chars allot
|
Line 229 create docline doclinelength chars allot
|
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] |
|