[ Top |
Files |
Routines |
Vars |
Pars |
Help
]
EOM
}
#/*@@
# @routine localnav
# @date Sun Apr 21 11:18:48 1996
# @author Paul Walker
# @desc
# Prints the local navigation stuff for a routine of file. This routine
# calls @seeroutine resolve_XRefs to generate the Foo [rich|raw]
# sort of things. Prints to OUT.
# @enddesc
# @calls resolve_XRefs
# @var thing
# @vdesc The file or routine which we want to generate the thing for
# @vtype string
# @vio in
# @endvar
# @var brief
# @vdesc Basically a string which, if defined, will cause a brief listing
# @vtype anything
# @vio in
# @vcomment
# Just a definition check here... A brief listing lacks the [ | ]
# after it.
# @endvar
# @var srcurl
# @vdesc A named link into the other frame for the richdoc
# @vtype string
# @vio in
# @vcomment
# An existance check is done, which sees if it should use this to
# generate the | show] link or not
# @endvar
# @comment Sorry...
# This is a little hairy...
# @endcomment
#@@*/
sub
localnav
# prints navigation for a routine or file to OUT, noncentered
{
local ($thing, $brief, $srcurl) = @_;
local ($msd);
if ($routine_home{$thing}) {
# We're dealing with a routine
$parent = $routine_home{$thing};
$richfile= &resolve_XRefs("\@seefile $parent");
$docfile = &resolve_XRefs("\@seefile $parent", "norich");
$routdoc = &resolve_XRefs("\@seeroutine $thing", "norich");
$rawsrc = $docfile;
$rawsrc =~ s:_File_Doc:_src:;
$rawsrc =~ s:\.html:.html\#$thing:;
$rawsrc =~ s:$opt_t/:$opt_t/PROTECTED/:;
$tree = $routdoc;
$tree =~ s:_Routine_Doc:_Routine_Tree:;
# OK, so now change the text
$richfile =~ s:>$parent:>rich:;
$rawsrc =~ s:>$parent:>raw:;
$tree =~ s:>$thing:>tree:;
# And make the link
print OUT "Routine " if !$brief;
print OUT "$routdoc [$tree";
if (!$brief) {
print OUT "]\n in file ";
$msd = $mysubdir{$parent};
if ($msd =~ m:\S:) {
print OUT "";
print OUT "src/$msd/";
} else {
print OUT "";
print OUT "src/";
}
print OUT "$docfile ";
print OUT "[$richfile | $rawsrc]\n";
} else {
if ($srcurl) {
print OUT " | ";
print OUT "show ]\n";
} else {
print OUT "]\n";
}
}
} elsif ($mysubdir{$thing} || $rootfiles{$thing}) {
# We're dealing with a file
$richfile= &resolve_XRefs("\@seefile $thing");
$docfile = &resolve_XRefs("\@seefile $thing", "norich");
$rawsrc = $docfile;
$rawsrc =~ s:_File_Doc:_src:;
$rawsrc =~ s:$opt_t/:$opt_t/PROTECTED/:;
# OK, so now change the text
$richfile =~ s:>$thing:>rich:;
$rawsrc =~ s:>$thing:>raw:;
# And make the link
print OUT "File " if !$brief;
print OUT "$docfile ";
print OUT "[$richfile | $rawsrc]\n";
if (!$brief) {
print OUT "in ";
$msd = $mysubdir{$thing};
if ($msd =~ m:\S:) {
print OUT "";
print OUT "src/$msd/";
} else {
print OUT "";
print OUT "src/";
}
}
} else {
# We're dealing with an unresolved XRef
print OUT "Unknown " if !$brief;
print OUT "$thing";
print OUT "";
}
}
#/*@@
# @routine html_safe
# @date Sun Apr 21 11:24:39 1996
# @author Paul Walker
# @desc
# Makes stuff safe for inclusion in html (eg, turns < > & into < etc..)
# but still pays attention to img and a href tags, which live!
#
# Note, if an optional second argument is passed, NO html survives!
# @enddesc
#@@*/
sub
html_safe
# Makes lines safe for html folks but protects hrefs, img src, and div.
{
local ($value, $supersafe) = @_;
$value =~ s:\&:\&\;:g;
$value =~ s:<(/a|div|/div|img src=[^>]+|a href=[^>]+)>:\<\;\1\>\;:g
if (!$supersafe);
$value =~ s:<:\<\;:g;
$value =~ s:>:\>\;:g;
if (!$supersafe) {
$value =~ s:\<\;:<:g;
$value =~ s:\>\;:>:g;
}
return $value;
}
#/*@@
# @routine indent
# @date Sun Apr 21 11:25:35 1996
# @author Paul Walker
# @desc
# Makes a table to indent 5%. Love those non-standard uses of html,
# eh?
# @enddesc
# @var dome
# @vdesc The thing to indent!
# @vtype string
# @vio in
# @endvar
# @returntype string
# @returndesc
# Returns $dome put in a 95% aligned table.
# @endreturndesc
# @comment
# Before you complain that I shouldn't use tables for layout, please
# consult the web page, where it says I don't care about what you
# think about how grdoc uses html.
# @endcomment
#@@*/
sub
indent
{
local ($dome) = @_[0];
$str = "
";
return $str;
}
#/*@@
# @routine de_punctualize
# @date Sun Apr 21 11:27:52 1996
# @author Paul Walker
# @desc
# Strips punctuation out of end of a routine. So if we pass foo, we
# get back an array which is ("foo", ",").
# @enddesc
# @var value
# @vdesc The thing to depunct
# @vtype string
# @vio in
# @endvar
# @returntype (string, string)
# @returndesc
# The first string is the depunctualized thing. The second is the
# punctuation which was stripped.
# @endreturndesc
# @comment
# Punctuation is a strange word, so if I misused it, deal!
# @endcomment
#@@*/
sub
de_punctualize
{
local ($value) = @_[0];
local ($nop, $punct);
if ($value =~ m:[\.\,\?\!\)\(]+$:) {
$nop = $value;
$nop =~ s:([\.\,\?\!\)\(]+)$::g;
$punct = $1;
} else {
$nop = $value;
$punct = "";
}
return ($nop, $punct);
}
# ? I love perl. :
1;