package HeaderDoc::Enum;
use HeaderDoc::Utilities qw(findRelativePath safeName getAPINameAndDisc printArray printHash);
use HeaderDoc::HeaderElement;
use HeaderDoc::MinorAPIElement;
use HeaderDoc::APIOwner;
@ISA = qw( HeaderDoc::HeaderElement );
use strict;
use vars qw($VERSION @ISA);
$VERSION = '1.20';
sub new {
my($param) = shift;
my($class) = ref($param) || $param;
my $self = {};
bless($self, $class);
$self->_initialize();
return($self);
}
sub _initialize {
my($self) = shift;
$self->SUPER::_initialize();
$self->{CONSTANTS} = ();
}
sub constants {
my $self = shift;
if (@_) {
@{ $self->{CONSTANTS} } = @_;
}
($self->{CONSTANTS}) ? return @{ $self->{CONSTANTS} } : return ();
}
sub addConstant {
my $self = shift;
if (@_) {
push (@{$self->{CONSTANTS}}, @_);
}
return @{ $self->{CONSTANTS} };
}
sub processEnumComment {
my $self = shift;
my $fieldArrayRef = shift;
my @fields = @$fieldArrayRef;
foreach my $field (@fields) {
SWITCH: {
($field =~ /^\/\*\!/)&& do {last SWITCH;}; ($field =~ s/^enum\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/^discussion\s+//) && do {$self->discussion($field); last SWITCH;};
($field =~ s/^updated\s+//) && do {$self->updated($field); last SWITCH;};
($field =~ s/^constant\s+//) &&
do {
$field =~ s/^\s+|\s+$//g;
$field =~ /(\w*)\s*(.*)/s;
my $cName = $1;
my $cDesc = $2;
my $cObj = HeaderDoc::MinorAPIElement->new();
$cObj->outputformat($self->outputformat);
$cObj->name($cName);
$cObj->discussion($cDesc);
$self->addConstant($cObj);
my $name = $self->name();
if ($name eq "") {
$name = "$cName";
$self->name($name);
}
last SWITCH;
};
my $filename = $HeaderDoc::headerObject->name();
print "$filename:0:Unknown field: $field\n";
}
}
}
sub getEnumDeclaration {
my $self = shift;
my $dec = shift;
my $localDebug = 0;
print "============================================================================\n" if ($localDebug);
print "Raw declaration is: $dec\n" if ($localDebug);
$dec =~ s/\t/ /g;
$dec =~ s/</</g;
$dec =~ s/>/>/g;
if (length ($dec)) {$dec = "<pre>\n$dec</pre>\n";};
print "Enum: returning declaration:\n\t|$dec|\n" if ($localDebug);
print "============================================================================\n" if ($localDebug);
return $dec;
}
sub documentationBlock {
my $self = shift;
my $name = $self->name();
my $abstract = $self->abstract();
my $updated = $self->updated();
my $desc = $self->discussion();
my $declaration = $self->declarationInHTML();
my @constants = $self->constants();
my $contentString;
my $apiUIDPrefix = HeaderDoc::APIOwner->apiUIDPrefix();
$contentString .= "<hr>";
$contentString .= "<a name=\"//$apiUIDPrefix/c/tag/$name\"></a>\n"; $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 = @constants;
if ($arrayLength > 0) {
$contentString .= "<h4>Constants</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 (@constants) {
my $cName = $element->name();
my $cDesc = $element->discussion();
$contentString .= "<tr><td align=\"center\"><a name=\"//$apiUIDPrefix/c/econst/$cName\"><tt>$cName</tt></a></td><td>$cDesc</td></tr>\n";
}
$contentString .= "</table>\n</blockquote>\n";
}
return $contentString;
}
sub XMLdocumentationBlock {
my $self = shift;
my $name = $self->name();
my $abstract = $self->abstract();
my $updated = $self->updated();
my $desc = $self->discussion();
my $declaration = $self->declarationInHTML();
my @constants = $self->constants();
my $contentString;
my $apiUIDPrefix = HeaderDoc::APIOwner->apiUIDPrefix();
$contentString .= "<enum id=\"//$apiUIDPrefix/c/tag/$name\">\n"; $contentString .= "<name>$name</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 = @constants;
if ($arrayLength > 0) {
$contentString .= "<constantlist>\n";
foreach my $element (@constants) {
my $cName = $element->name();
my $cDesc = $element->discussion();
$contentString .= "<constant id=\"//$apiUIDPrefix/c/econst/$cName\">\n";
$contentString .= "<name>$cName</name>\n";
$contentString .= "<description>$cDesc</description>\n";
$contentString .= "</constant>\n";
}
$contentString .= "</constantlist>\n";
}
$contentString .= "</enum>\n";
return $contentString;
}
sub printObject {
my $self = shift;
print "Enum\n";
$self->SUPER::printObject();
print "Constants:\n";
my $fieldArrayRef = $self->{CONSTANTS};
my $arrayLength = @{$fieldArrayRef};
if ($arrayLength > 0) {
&printArray(@{$fieldArrayRef});
}
print "\n";
}
1;