package HeaderDoc::Var;
use HeaderDoc::Utilities qw(findRelativePath safeName getAPINameAndDisc printArray printHash);
use HeaderDoc::HeaderElement;
use HeaderDoc::Struct;
@ISA = qw( HeaderDoc::Struct );
use strict;
use vars qw($VERSION @ISA);
$VERSION = '1.20';
sub processVarComment {
my($self) = shift;
my $fieldArrayRef = shift;
my @fields = @$fieldArrayRef;
foreach my $field (@fields) {
SWITCH: {
($field =~ /^\/\*\!/)&& do {last SWITCH;}; ($field =~ s/^var\s+//) &&
do {
my ($name, $disc);
($name, $disc) = &getAPINameAndDisc($field);
$self->name($name);
if (length($disc)) {$self->discussion($disc);};
last SWITCH;
};
($field =~ s/^abstract\s+//) && do {$self->abstract($field); last SWITCH;};
($field =~ s/^updated\s+//) && do {$self->updated($field); last SWITCH;};
($field =~ s/^discussion\s+//) && do {$self->discussion($field); last SWITCH;};
my $filename = $HeaderDoc::headerObject->name();
print "$filename:0:Unknown field: $field\n";
}
}
}
sub setVarDeclaration {
my($self) = shift;
my ($dec) = @_;
my $localDebug = 0;
print "============================================================================\n" if ($localDebug);
print "Raw var declaration is: $dec\n" if ($localDebug);
$dec =~ s/^extern\s+//;
$dec =~ s/\t/ /g;
$dec =~ s/^\s*//g;
$dec =~ s/</</g;
$dec =~ s/>/>/g;
if (length ($dec)) {$dec = "<pre>\n$dec</pre>\n";};
print "Var: returning declaration:\n\t|$dec|\n" if ($localDebug);
print "============================================================================\n" if ($localDebug);
$self->declarationInHTML($dec);
return $dec;
}
sub documentationBlock {
my $self = shift;
my $contentString;
my $name = $self->name();
my $abstract = $self->abstract();
my $updated = $self->updated();
my $desc = $self->discussion();
my $declaration = $self->declarationInHTML();
my @fields = $self->fields();
my $fieldHeading = "Fields";
if ($self->can('isFunctionPointer')) {
if ($self->isFunctionPointer()) {
$fieldHeading = "Parameters";
}
}
my $methodType = "var"; my $methodType = "defn";
$contentString .= "<hr>";
$contentString .= $self->appleref($methodType);
$contentString .= "<table border=\"0\" cellpadding=\"2\" cellspacing=\"2\" width=\"300\">";
$contentString .= "<tr>";
$contentString .= "<td valign=\"top\" height=\"12\" colspan=\"5\">";
$contentString .= "<h2><a name=\"$name\">$name</a></h2>\n";
$contentString .= "</td>";
$contentString .= "</tr></table>";
$contentString .= "<hr>";
if (length($abstract)) {
$contentString .= "$abstract\n";
}
if (length($updated)) {
$contentString .= "<b>Updated:</b> $updated\n";
}
$contentString .= "<blockquote>$declaration</blockquote>\n";
$contentString .= "<p>$desc</p>\n";
my $arrayLength = @fields;
if ($arrayLength > 0) {
$contentString .= "<h4>$fieldHeading</h4>\n";
$contentString .= "<blockquote>\n";
$contentString .= "<table border=\"1\" width=\"90%\">\n";
$contentString .= "<thead><tr><th>Name</th><th>Description</th></tr></thead>\n";
foreach my $element (@fields) {
my $fName;
my $fDesc;
$element =~ s/^\s+|\s+$//g;
$element =~ /(\w*)\s*(.*)/;
$fName = $1;
$fDesc = $2;
$contentString .= "<tr><td align=\"center\"><tt>$fName</tt></td><td>$fDesc</td></tr>\n";
}
$contentString .= "</table>\n</blockquote>\n";
}
return $contentString;
}
sub XMLdocumentationBlock {
my $self = shift;
my $contentString;
my $name = $self->name();
my $abstract = $self->abstract();
my $updated = $self->updated();
my $desc = $self->discussion();
my $declaration = $self->declarationInHTML();
my @fields = $self->fields();
my $fieldHeading = "Fields";
if ($self->can('isFunctionPointer')) {
if ($self->isFunctionPointer()) {
$fieldHeading = "Parameters";
}
}
$contentString .= "<variable id=\"$name\">\n";
if (length($abstract)) {
$contentString .= "<abstract>$abstract</abstract>\n";
}
if (length($updated)) {
$contentString .= "<updated>$updated</updated>\n";
}
$contentString .= "<declaration>$declaration</declaration>\n";
$contentString .= "<description>$desc</description>\n";
my $arrayLength = @fields;
if ($arrayLength > 0) {
$contentString .= "<heading>$fieldHeading</heading>\n";
$contentString .= "<fieldlist>\n";
foreach my $element (@fields) {
my $fName;
my $fDesc;
$element =~ s/^\s+|\s+$//g;
$element =~ /(\w*)\s*(.*)/;
$fName = $1;
$fDesc = $2;
$contentString .= "<field><name>$fName</name><description>$fDesc</description></field>\n";
}
$contentString .= "</fieldlist\n";
}
$contentString .= "</variable>\n";
return $contentString;
}
sub printObject {
my $self = shift;
print "Var\n";
$self->SUPER::printObject();
print "\n";
}
1;