File:  [gforth] / gforth / glosgen.glo
Revision (vendor branch): download - view: text, annotated - select for diffs
Fri Feb 11 16:30:47 1994 UTC (29 years, 9 months ago) by anton
Branches: no-vendor, MAIN
CVS tags: v0-7-0, v0-6-2, v0-6-1, v0-6-0, v0-5-0, v0-4-0, v0-3-0, v0-2-1, v0-2-0, gforth-0_1beta, alpha, HEAD
The GNU Forth Project

\G comments should appear immediately above or below the definition of
the word it belongs to. The definition line should contain no more
than the definition, a stack comment and a \ comment after which
the wordset and pronounciation.
An isolated block of \G comments is placed at the beginning of the
glossary file.

A typical glossary session may look like:

BUILD-HLINE   addr ---                                                         
Build header line for glossary entry.

GLOS-COMMENT?   --- flag                                                       
Determine if line at HERE is glossary comment, if so.
allot it, else store into oldline.

INSERT-HEADER   addr ---                                                       
Insert the header into the list at the alphabetically correct place.

MAKE-GLOSENTRY   fid --- fid flag                                              
Read lines from the file fid until \G line encountered.
Collect all adjacent \G lines and find header line.
then insert entry into list flag=0 if no entry found.

MAKEGLOS   "name"                                                              
This command reads a source file and builds glossary info
for it in memory.

This command starts a fresh glossary.

Process the header information stored in OLDLINE

SCAN-WORD   ---- addr len                                                      
Scan a word on oldline through pointer charptr

WRITE-GLOSENTRY   addr fid ---                                                 
write the glossary entry at address addr to file fid.

WRITEGLOS   "name"                                                             
This command writes the glossary info from memory to a file.
The glossary info may be collected from more source files.

\G is an alias for \, so it is a comment till end-of-line, but
it has a special meaning for the Glossary Generator.

FreeBSD-CVSweb <>