package HeaderDoc::Enum;
use HeaderDoc::Utilities qw(findRelativePath safeName getAPINameAndDisc printArray printHash validTag);
use HeaderDoc::HeaderElement;
use HeaderDoc::MinorAPIElement;
use HeaderDoc::APIOwner;
@ISA = qw( HeaderDoc::HeaderElement );
use strict;
use vars qw($VERSION @ISA);
$VERSION = '$Revision: 1.10.2.9.2.31 $';
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->{CLASS} = "HeaderDoc::Enum";
}
sub clone {
my $self = shift;
my $clone = undef;
if (@_) {
$clone = shift;
} else {
$clone = HeaderDoc::Enum->new();
}
$self->SUPER::clone($clone);
return $clone;
}
sub processComment {
my $self = shift;
my $fieldArrayRef = shift;
my @fields = @$fieldArrayRef;
my $filename = $self->filename();
my $linenum = $self->linenum();
foreach my $field (@fields) {
my $fieldname = "";
my $top_level_field = 0;
if ($field =~ /^(\w+)(\s|$)/) {
$fieldname = $1;
$top_level_field = validTag($fieldname, 1);
}
SWITCH: {
($field =~ /^\/\*\!/o)&& do {
my $copy = $field;
$copy =~ s/^\/\*\!\s*//s;
if (length($copy)) {
$self->discussion($copy);
}
last SWITCH;
};
($field =~ s/^abstract\s+//io) && do {$self->abstract($field); last SWITCH;};
($field =~ s/^brief\s+//io) && do {$self->abstract($field, 1); last SWITCH;};
($field =~ s/^discussion(\s+|$)//io) && do {$self->discussion($field); last SWITCH;};
($field =~ s/^availability\s+//io) && do {$self->availability($field); last SWITCH;};
($field =~ s/^since\s+//io) && do {$self->availability($field); last SWITCH;};
($field =~ s/^author\s+//io) && do {$self->attribute("Author", $field, 0); last SWITCH;};
($field =~ s/^version\s+//io) && do {$self->attribute("Version", $field, 0); last SWITCH;};
($field =~ s/^deprecated\s+//io) && do {$self->attribute("Deprecated", $field, 0); last SWITCH;};
($field =~ s/^updated\s+//io) && do {$self->updated($field); last SWITCH;};
($field =~ s/^attribute\s+//io) && do {
my ($attname, $attdisc, $namedisc) = &getAPINameAndDisc($field);
if (length($attname) && length($attdisc)) {
$self->attribute($attname, $attdisc, 0);
} else {
warn "$filename:$linenum: warning: Missing name/discussion for attribute\n";
}
last SWITCH;
};
($field =~ s/^attributelist\s+//io) && do {
$field =~ s/^\s*//so;
$field =~ s/\s*$//so;
my ($name, $lines) = split(/\n/, $field, 2);
$name =~ s/^\s*//so;
$name =~ s/\s*$//so;
$lines =~ s/^\s*//so;
$lines =~ s/\s*$//so;
if (length($name) && length($lines)) {
my @attlines = split(/\n/, $lines);
foreach my $line (@attlines) {
$self->attributelist($name, $line);
}
} else {
warn "$filename:$linenum: warning: Missing name/discussion for attributelist\n";
}
last SWITCH;
};
($field =~ s/^attributeblock\s+//io) && do {
my ($attname, $attdisc, $namedisc) = &getAPINameAndDisc($field);
if (length($attname) && length($attdisc)) {
$self->attribute($attname, $attdisc, 1);
} else {
warn "$filename:$linenum: warning: Missing name/discussion for attributeblock\n";
}
last SWITCH;
};
($field =~ /^see(also|)\s+/io) &&
do {
$self->see($field);
last SWITCH;
};
($field =~ s/^const(ant)?\s+//io) &&
do {
$field =~ s/^\s+|\s+$//go;
$field =~ /(\S*)\s*(.*)/so; 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;
};
($top_level_field == 1) &&
do {
my $keepname = 1;
if ($field =~ s/^(enum)(\s+|$)/$2/io) {
$keepname = 1;
} else {
$field =~ s/(\w+)(\s|$)/$2/io;
$keepname = 0;
}
my ($name, $disc, $namedisc);
($name, $disc, $namedisc) = &getAPINameAndDisc($field);
$self->name($name);
if (length($disc)) {
if ($namedisc) {
$self->nameline_discussion($disc);
} else {
$self->discussion($disc);
}
}
last SWITCH;
};
my $filename = $self->filename();
my $linenum = $self->linenum();
if (length($field)) { warn "$filename:$linenum: warning: Unknown field (\@$field) in enum comment (".$self->name().")\n"; }
}
}
}
sub getEnumDeclaration {
my $self = shift;
my $dec = shift;
my $localDebug = 0;
print "============================================================================\n" if ($localDebug);
print "Raw declaration is: $dec\n" if ($localDebug);
if ($HeaderDoc::use_styles) {
return $dec;
}
$dec =~ s/\t/ /go;
$dec =~ s/</</go;
$dec =~ s/>/>/go;
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 printObject {
my $self = shift;
print "Enum\n";
$self->SUPER::printObject();
print "Constants:\n";
}
1;