::CLASS rexxliterate PUBLIC
render tree of rexx files as HTML, optional tree view
Requires
'condhandler.cls' conditions
'fsobjects.cls' for all the boilerplate
'hashfunction.cls' to generate unique ids
'rexxprogram.cls' rexx program parser
'htmlout.cls' html output
'documents.cls' files, folders, rexx and text documents
'nodes.cls' html images to build the tree view
'htmltree.cls' build tree html
'htmlindex.cls' index html
'pathsep.cls' fs path separator
Definition at line
136 of
rexxliterate.cls
Public Methods
|
|
top folder of tree
|
buildtree
()
|
|
return a tree of folders and files
|
|
|
emit
(treeframe)
|
|
produce HTML output
|
|
|
init
(config)
|
|
build the tree of folders and files
|
Public Attributes
|
|
|
globalix
|
|
global lists of features and files
|
|
|
hdest
|
|
path to html output
|
|
|
htmlout
|
|
html output object
|
|
|
modules
|
|
.directory of module rexxdocs harvested from text
|
|
|
prefixcomment
|
|
remove from comment prefix
|
|
|
recursive
|
|
when true, recurses into folder tree
|
|
|
rexxdocs
|
|
rexxdocs harvested from text
|
|
|
rsource
|
|
path to rex source
|
|
|
title
|
|
title for report
|
|
|
trailericon
|
|
inserted into left hand side of page trailers
|
|
|
tree
|
|
tree of folders and files from rsource
|
Private Methods
|
|
|
addnature
(f)
|
|
walk tree, add HTML methods to documents and contents
|
|
|
html
(f)
|
|
walk tree, emit per document HTML
|
|
|
parser
(f)
|
|
walk tree, parse document
|
|
|
treewalk
(f)
|
|
recursively walk folders in a tree
|
|
|
xref
(f)
|
|
walk tree, xref document
|
Instantiated by
rexxliterate.rex line 109
test.rex line 109
Feature Detail
 ::ATTRIBUTE rsource
|
path to rex source
Dynamically referenced by
rexxliterate.cls line 162 "
self~rsource = config~rsource"
rexxliterate.cls line 162 "
self~rsource = config~rsource"
rexxliterate.cls line 176 "
self~tree = self~buildtree(self~rsource)"
rexxliterate.cls line 180 "
raise SYNTAX 93 ARRAY('no input files in' self~rsource)"
rexxliterate.cls line 354 "
i~document = .rexxdocument~new(i, self~rsource, self~globalix)"
rexxliterate.cls line 358 "
i~document = .textdocument~new(i, self~rsource, self~rexxdocs, self~modules)"
rexxliterate.cls line 425 "
top = .folder~new(self~rsource)"
rexxliterate.rex line 101 "
config~rsource = .pathsep~localpath(rpath)"
test.rex line 101 "
config~rsource = .pathsep~localpath(rpath)"
|
::ATTRIBUTE hdest
|
path to html output
Dynamically referenced by
htmlindex.cls line 123 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 163 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 199 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 225 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 248 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 271 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 293 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 316 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 345 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 367 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 398 "
call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlrexxclass.cls line 199 "
towrite = self~htmlout~hdest||rdc~hdocurl"
htmlrexxprogram.cls line 257 "
towrite = htmlout~hdest||file~document~hdocurl"
htmlrexxsource.cls line 105 "
towrite = self~htmlout~hdest||file~document~hsrcurl"
htmltext.cls line 92 "
towrite = htmlout~hdest||file~document~hsrcurl"
rexxliterate.cls line 163 "
self~hdest = config~hdest"
rexxliterate.cls line 163 "
self~hdest = config~hdest"
rexxliterate.cls line 208 "
call bwritefiles self~hdest"
rexxliterate.cls line 214 "
self~htmlout = .htmlout~new(self, self~hdest, self~pversion, self~title, self~prefixcomment, self~trailericon)"
rexxliterate.cls line 234 "
t = .htmltree~new(self~title, self~tree, self~hdest)"
rexxliterate.rex line 102 "
config~hdest = .pathsep~localpath(hdest)"
test.rex line 102 "
config~hdest = .pathsep~localpath(hdest)"
|
::ATTRIBUTE title
|
title for report
Dynamically referenced by
htmlout.cls line 109 "
mh~queue('<title>'self~title 'Documents</title>')"
htmlutil.cls line 257 "
tp~queue('Generated on' date() time() 'for' htmlout~title 'by')"
rexxliterate.cls line 164 "
self~title = config~title"
rexxliterate.cls line 164 "
self~title = config~title"
rexxliterate.cls line 214 "
self~htmlout = .htmlout~new(self, self~hdest, self~pversion, self~title, self~prefixcomment, self~trailericon)"
rexxliterate.cls line 234 "
t = .htmltree~new(self~title, self~tree, self~hdest)"
rexxliterate.rex line 103 "
config~title = title"
test.rex line 103 "
config~title = title"
|
::ATTRIBUTE prefixcomment
|
remove from comment prefix
Dynamically referenced by
rexxliterate.cls line 167 "
self~prefixcomment = config~prefixcomment"
rexxliterate.cls line 167 "
self~prefixcomment = config~prefixcomment"
rexxliterate.cls line 214 "
self~htmlout = .htmlout~new(self, self~hdest, self~pversion, self~title, self~prefixcomment, self~trailericon)"
rexxliterate.rex line 105 "
config~prefixcomment = pf"
test.rex line 105 "
config~prefixcomment = pf"
|
::ATTRIBUTE trailericon
|
inserted into left hand side of page trailers
Dynamically referenced by
htmlutil.cls line 252 "
tp~queue(htmlout~trailericon)"
rexxliterate.cls line 166 "
self~trailericon = config~trailericon"
rexxliterate.cls line 166 "
self~trailericon = config~trailericon"
rexxliterate.cls line 214 "
self~htmlout = .htmlout~new(self, self~hdest, self~pversion, self~title, self~prefixcomment, self~trailericon)"
rexxliterate.rex line 106 "
config~trailericon = '<a href="http://sourceforge.net/projects/rexxliterate"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=266417&type=10" width="80" height="15" alt="Get RexxLiterate at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a>'"
test.rex line 106 "
config~trailericon = '<a href="http://sourceforge.net/projects/rexxliterate"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=266417&type=10" width="80" height="15" alt="Get RexxLiterate at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a>'"
 ::ATTRIBUTE pversion PRIVATE
|
my version
Dynamically referenced by
rexxliterate.cls line 160 "
self~pversion = '0.0.1'"
rexxliterate.cls line 214 "
self~htmlout = .htmlout~new(self, self~hdest, self~pversion, self~title, self~prefixcomment, self~trailericon)"
|
::ATTRIBUTE globalix
|
global lists of features and files
Dynamically referenced by
classfinder.cls line 104 "
rdc = document~globalix~classix[classname]"
classfinder.cls line 157 "
rdp = document~globalix~routinix[routinename]"
documents.cls line 644 "
if \self~document~globalix~dynamicmethods"
documents.cls line 729 "
rdma = self~document~globalix~methix~allat(meth)"
documents.cls line 743 "
rdma = self~document~globalix~attrix~allat(meth)"
documents.cls line 775 "
irdc = self~document~globalix~classix~at(m~translate)"
documents.cls line 787 "
mrdc = self~document~globalix~classix~at(rdc~mixinclass~translate)"
documents.cls line 798 "
srdc = self~document~globalix~classix~at(rdc~subclass~translate)"
htmlrexxclass.cls line 275 "
rdc = self~htmlout~rexxliterate~globalix~classix~at(supername~translate)"
htmlrexxclass.cls line 294 "
rdc = self~htmlout~rexxliterate~globalix~classix~at(mixname~translate)"
htmlrexxsource.cls line 220 "
irdc = rdc~document~globalix~classix[w~translate]"
rexxliterate.cls line 172 "
self~globalix = .globalindex~new()"
rexxliterate.cls line 173 "
self~globalix~dynamicmethods = config~dynamicmethods"
rexxliterate.cls line 224 "
.htmlindex~emit(self~htmlout, self~globalix)"
rexxliterate.cls line 267 "
i~document~xref(self~globalix)"
rexxliterate.cls line 354 "
i~document = .rexxdocument~new(i, self~rsource, self~globalix)"
rexxliterate.cls line 397 "
self~htmlout~rhtmlpage(f, i, self~globalix)"
rexxliterate.cls line 438 "
self~globalix~folders~queue(f)"
rexxliterate.cls line 459 "
self~globalix~files~queue(i)"
rexxliterate.cls line 460 "
self~globalix~filix[i~filename] = i"
|
::ATTRIBUTE recursive
|
when true, recurses into folder tree
Dynamically referenced by
rexxliterate.cls line 165 "
self~recursive = config~recurse"
rexxliterate.cls line 464 "
if \self~recursive"
|
::ATTRIBUTE rexxdocs
|
rexxdocs harvested from text
Dynamically referenced by
rexxliterate.cls line 169 "
self~rexxdocs = .queue~new"
rexxliterate.cls line 228 "
self~htmlout~firstpage(self~rexxdocs, treeframe)"
rexxliterate.cls line 358 "
i~document = .textdocument~new(i, self~rsource, self~rexxdocs, self~modules)"
|
::ATTRIBUTE modules
|
.directory of module rexxdocs harvested from text
Dynamically referenced by
htmlout.cls line 92 "
if rexxliterate~modules~items > 0"
rexxliterate.cls line 170 "
self~modules = .directory~new"
rexxliterate.cls line 230 "
self~htmlout~modules(self~modules)"
rexxliterate.cls line 230 "
self~htmlout~modules(self~modules)"
rexxliterate.cls line 358 "
i~document = .textdocument~new(i, self~rsource, self~rexxdocs, self~modules)"
|
::ATTRIBUTE htmlout
|
html output object
Dynamically referenced by
rexxliterate.cls line 214 "
self~htmlout = .htmlout~new(self, self~hdest, self~pversion, self~title, self~prefixcomment, self~trailericon)"
rexxliterate.cls line 224 "
.htmlindex~emit(self~htmlout, self~globalix)"
rexxliterate.cls line 228 "
self~htmlout~firstpage(self~rexxdocs, treeframe)"
rexxliterate.cls line 230 "
self~htmlout~modules(self~modules)"
rexxliterate.cls line 240 "
if self~htmlout~pwrongdoc~items > 0"
rexxliterate.cls line 243 "
do i over self~htmlout~pwrongdoc"
rexxliterate.cls line 247 "
if self~htmlout~pmissingdoc~items > 0"
rexxliterate.cls line 250 "
do i over self~htmlout~pmissingdoc"
rexxliterate.cls line 397 "
self~htmlout~rhtmlpage(f, i, self~globalix)"
rexxliterate.cls line 402 "
self~htmlout~thtmlpage(f, i)"
 ::METHOD init
|
build the tree of folders and files
Parameters
config - configuration object
|
::METHOD emit
|
produce HTML output
Parameters
treeframe - when .true produce frameset and HTML tree when .false main.html = index.html and no HTML tree
Dynamically referenced by
rexxliterate.rex line 112 "
hrexx~emit(.true)"
test.rex line 112 "
hrexx~emit(.true)"
 ::METHOD xref PRIVATE
|
walk tree, xref document
Parameters
f - folder tree to walk
Dynamically referenced by
rexxliterate.cls line 191 "
self~xref(self~tree)"
rexxliterate.cls line 277 "
self~xref(i)"
|
::METHOD addnature PRIVATE
|
walk tree, add HTML methods to documents and contents
Parameters
f - folder tree to walk
Dynamically referenced by
rexxliterate.cls line 211 "
self~addnature(self~tree)"
rexxliterate.cls line 341 "
self~addnature(i)"
|
::METHOD parser PRIVATE
|
walk tree, parse document
Parameters
f - folder tree to walk
Dynamically referenced by
rexxliterate.cls line 187 "
self~parser(self~tree)"
rexxliterate.cls line 366 "
self~parser(i)"
|
::METHOD html PRIVATE
|
walk tree, emit per document HTML
Parameters
f - folder tree to walk
Dynamically referenced by
rexxliterate.cls line 220 "
self~html(self~tree)"
rexxliterate.cls line 377 "
self~html(i)"
|
::METHOD buildtree
|
return a tree of folders and files
Returns
top folder of tree
Dynamically referenced by
rexxliterate.cls line 176 "
self~tree = self~buildtree(self~rsource)"
|
::METHOD treewalk PRIVATE
|
recursively walk folders in a tree
Parameters
f - current folder
Dynamically referenced by
rexxliterate.cls line 428 "
self~treewalk(top)"
rexxliterate.cls line 482 "
self~treewalk(i)"
|
Generated on 31 Aug 2010 05:20:31 for RexxLiterate by
0.0.1
|