package HeaderDoc::Typedef;
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->{FIELDS} = ();
$self->{CLASS} = "HeaderDoc::Typedef";
}
sub clone {
my $self = shift;
my $clone = undef;
if (@_) {
$clone = shift;
} else {
$clone = HeaderDoc::Typedef->new();
}
$self->SUPER::clone($clone);
$clone->{RESULT} = $self->{RESULT};
$clone->{FIELDS} = $self->{FIELDS};
$clone->{ISFUNCPTR} = $self->{ISFUNCPTR};
$clone->{ISENUMLIST} = $self->{ISENUMLIST};
return $clone;
}
sub result {
my $self = shift;
if (@_) {
$self->{RESULT} = shift;
}
return $self->{RESULT};
}
sub fields {
my $self = shift;
if (@_) {
@{ $self->{FIELDS} } = @_;
}
($self->{FIELDS}) ? return @{ $self->{FIELDS} } : return ();
}
sub addField {
my $self = shift;
my $localDebug = 0;
if (@_) {
foreach my $field (@_) {
print "added field $field->{NAME} ($field->{TYPE})\n" if ($localDebug);
push(@{$self->{FIELDS}}, $field);
}
}
return @{ $self->{FIELDS} };
}
sub isEnumList {
my $self = shift;
if (@_) {
$self->{ISENUMLIST} = shift;
}
return $self->{ISENUMLIST};
}
sub processComment {
my $self = shift;
my $fieldArrayRef = shift;
my @fields = @$fieldArrayRef;
my $lastField = scalar(@fields);
my $filename = $self->filename();
my $linenum = $self->linenum();
my $fieldCounter = 0;
my $localDebug = 0;
while ($fieldCounter < $lastField) {
my $field = $fields[$fieldCounter];
print "FIELD WAS $field\n" if ($localDebug);
SWITCH: {
($field =~ /^\/\*\!/o)&& do {last SWITCH;}; ($field =~ s/^(typedef|function)(\s+)/$2/o) &&
do {
my ($name, $disc);
($name, $disc) = &getAPINameAndDisc($field);
$self->name($name);
if (length($disc)) {$self->discussion($disc);};
last SWITCH;
};
($field =~ s/^abstract\s+//o) && do {$self->abstract($field); last SWITCH;};
($field =~ s/^availability\s+//o) && do {$self->availability($field); last SWITCH;};
($field =~ s/^since\s+//o) && do {$self->availability($field); last SWITCH;};
($field =~ s/^author\s+//o) && do {$self->attribute("Author", $field, 0); last SWITCH;};
($field =~ s/^version\s+//o) && do {$self->attribute("Version", $field, 0); last SWITCH;};
($field =~ s/^deprecated\s+//o) && do {$self->attribute("Deprecated", $field, 0); last SWITCH;};
($field =~ s/^updated\s+//o) && do {$self->updated($field); last SWITCH;};
($field =~ s/^attribute\s+//o) && do {
my ($attname, $attdisc) = &getAPINameAndDisc($field);
if (length($attname) && length($attdisc)) {
$self->attribute($attname, $attdisc, 0);
} else {
warn "$filename:$linenum:Missing name/discussion for attribute\n";
}
last SWITCH;
};
($field =~ s/^attributelist\s+//o) && 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:Missing name/discussion for attributelist\n";
}
last SWITCH;
};
($field =~ s/^attributeblock\s+//o) && do {
my ($attname, $attdisc) = &getAPINameAndDisc($field);
if (length($attname) && length($attdisc)) {
$self->attribute($attname, $attdisc, 1);
} else {
warn "$filename:$linenum:Missing name/discussion for attributeblock\n";
}
last SWITCH;
};
($field =~ /^see(also|)\s+/o) &&
do {
$self->see($field);
last SWITCH;
};
($field =~ s/^discussion\s+//o) && do {$self->discussion($field); last SWITCH;};
($field =~ s/^field\s+//o) &&
do {
$field =~ s/^\s+|\s+$//go;
$field =~ /(\w*)\s*(.*)/so;
my $fName = $1;
my $fDesc = $2;
my $fObj = HeaderDoc::MinorAPIElement->new();
$fObj->outputformat($self->outputformat);
$fObj->name($fName);
$fObj->discussion($fDesc);
$fObj->type("field");
$self->addField($fObj);
print "Adding field for typedef. Field name: $fName.\n" if ($localDebug);
last SWITCH;
};
($field =~ s/^constant\s+//o) &&
do {
$self->isEnumList(1);
$field =~ s/^\s+|\s+$//go;
$field =~ /(\w*)\s*(.*)/so;
my $fName = $1;
my $fDesc = $2;
my $fObj = HeaderDoc::MinorAPIElement->new();
$fObj->outputformat($self->outputformat);
$fObj->name($fName);
$fObj->discussion($fDesc);
$fObj->type("constant");
$self->addConstant($fObj);
last SWITCH;
};
($field =~ s/^callback\s+//o) &&
do {
$field =~ s/^\s+|\s+$//go;
$field =~ /(\w*)\s*(.*)/so;
my $cbName = $1;
my $cbDesc = $2;
my $callbackObj = HeaderDoc::MinorAPIElement->new();
$callbackObj->outputformat($self->outputformat);
$callbackObj->name($cbName);
$callbackObj->discussion($cbDesc);
$callbackObj->type("callback");
print "Adding callback. Callback name: $cbName.\n" if ($localDebug);
$fieldCounter++;
while ($fieldCounter < $lastField) {
my $nextField = $fields[$fieldCounter];
print "In callback: next field is '$nextField'\n" if ($localDebug);
if ($nextField =~ s/^param\s+//o) {
$nextField =~ s/^\s+|\s+$//go;
$nextField =~ /(\w*)\s*(.*)/so;
my $paramName = $1;
my $paramDesc = $2;
$callbackObj->addToUserDictArray({"$paramName" => "$paramDesc"});
} elsif ($nextField eq "result") {
$nextField =~ s/^\s+|\s+$//go;
$nextField =~ /(\w*)\s*(.*)/so;
my $resultName = $1;
my $resultDesc = $2;
$callbackObj->addToUserDictArray({"$resultName" => "$resultDesc"});
} else {
last;
}
$fieldCounter++;
}
$self-> addField($callbackObj);
print "Adding callback to typedef. Callback name: $cbName.\n" if ($localDebug);
last SWITCH;
};
($field =~ s/^param\s+//o) &&
do {
$self->isFunctionPointer(1);
$field =~ s/^\s+|\s+$//go;
$field =~ /(\w*)\s*(.*)/so;
my $fName = $1;
my $fDesc = $2;
my $fObj = HeaderDoc::MinorAPIElement->new();
$fObj->outputformat($self->outputformat);
$fObj->name($fName);
$fObj->discussion($fDesc);
$fObj->type("funcPtr");
$self->addField($fObj);
print "Adding param for function-pointer typedef. Param name: $fName.\n" if ($localDebug);
last SWITCH;
};
($field =~ s/^result\s+//o || s/^return\s+//o) &&
do {
$self->isFunctionPointer(1);
$self->result($field);
last SWITCH;
};
my $filename = $self->filename();
my $linenum = $self->linenum();
if (length($field)) { warn "$filename:$linenum:Unknown field (\@$field) in typedef comment (".$self->name().")\n"; }
}
$fieldCounter++;
}
}
sub setTypedefDeclaration {
my $self = shift;
my $dec = shift;
my $decType;
my $localDebug = 0;
my $filename = $self->filename();
my $linenum = $self->linenum();
if ($self->isFunctionPointer() && $dec =~ /typedef(\s+\w+)*\s+\{/o) {
$self->isFunctionPointer(0);
warn("$filename:$linenum:Typedef markup invalid. Non-callback typedefs\n");
warn("should use \@field, not \@param.\n");
}
$self->declaration($dec);
$self->declarationInHTML($dec);
return $dec;
}
sub printObject {
my $self = shift;
print "Typedef\n";
$self->SUPER::printObject();
SWITCH: {
if ($self->isFunctionPointer()) {print "Parameter Descriptions:\n"; last SWITCH; }
if ($self->isEnumList()) {print "Constants:\n"; last SWITCH; }
print "Field Descriptions:\n";
}
my $fieldArrayRef = $self->{FIELDS};
if ($fieldArrayRef) {
my $arrayLength = @{$fieldArrayRef};
if ($arrayLength > 0) {
&printArray(@{$fieldArrayRef});
}
}
print "is function pointer: $self->{ISFUNCPTR}\n";
print "is enum list: $self->{ISENUMLIST}\n";
print "\n";
}
1;