package HeaderDoc::PDefine;
use HeaderDoc::Utilities qw(findRelativePath safeName getAPINameAndDisc convertCharsForFileMaker printArray printHash validTag);
use HeaderDoc::HeaderElement;
@ISA = qw( HeaderDoc::HeaderElement );
use strict;
use vars qw($VERSION @ISA);
$VERSION = '$Revision: 1.9.2.8.2.44 $';
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->{BLOCKDISCUSSION} = "";
$self->{PARSETREELIST} = ();
$self->{PARSEONLY} = ();
$self->{CLASS} = "HeaderDoc::PDefine";
}
sub clone {
my $self = shift;
my $clone = undef;
if (@_) {
$clone = shift;
} else {
$clone = HeaderDoc::PDefine->new();
}
$self->SUPER::clone($clone);
$clone->{ISBLOCK} = $self->{ISBLOCK};
$clone->{RESULT} = $self->{RESULT};
$clone->{BLOCKDISCUSSION} = $self->{BLOCKDISCUSSION};
$clone->{PARSETREELIST} = $self->{PARSETREELIST};
$clone->{PARSEONLY} = $self->{PARSEONLY};
return $clone;
}
sub discussion
{
my $self = shift;
my $localDebug = 0;
if (@_) {
if ($localDebug) {
print "Set Discussion for #define (or block) to ".@_[0]."..\n";
}
return $self->SUPER::discussion(@_);
}
my $realdisc = $self->SUPER::discussion();
if (!length($realdisc) || ($realdisc !~ /\s/)) {
return $self->blockDiscussion();
}
return $realdisc;
}
sub processComment {
my $localDebug = 0;
my($self) = shift;
my $fieldArrayRef = shift;
my @fields = @$fieldArrayRef;
my $filename = $self->filename();
my $linenum = $self->linenum();
my $olddisc = $self->discussion();
foreach my $field (@fields) {
my $fieldname = "";
my $top_level_field = 0;
if ($field =~ /^(\w+)(\s|$)/) {
$fieldname = $1;
$top_level_field = validTag($fieldname, 1);
}
if ($localDebug) { print "FIELD: $field\n"; }
chomp($field);
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 {
if ($self->inDefineBlock() && length($olddisc)) {
$self->{DISCUSSION} = "";
}
if (!length($field)) { $field = "\n"; }
$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/^parseOnly(\s+|$)//io) && do { $self->parseOnly(1); last SWITCH; };
($field =~ s/^noParse(\s+|$)//io) && do { print "Parsing will be skipped.\n" if ($localDebug); $HeaderDoc::skipNextPDefine = 1; last SWITCH; };
($field =~ s/^(param|field)\s+//io) && do {
$field =~ s/^\s+|\s+$//go; # trim leading and trailing whitespace
$field =~ /(\S*)\s*(.*)/so;
my $pName = $1;
my $pDesc = $2;
my $param = HeaderDoc::MinorAPIElement->new();
$param->outputformat($self->outputformat);
$param->name($pName); $param->discussion($pDesc);
$self->addTaggedParameter($param);
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/^return\s+//io) && do {$self->result($field); last SWITCH;};
($field =~ s/^result\s+//io) && do {$self->result($field); last SWITCH;};
($top_level_field == 1) && do {
my $keepname = 1;
my $blockrequest = 0;
if ($field =~ s/^(define(?:d)?|function)(\s+|$)/$2/io) {
$keepname = 1;
$blockrequest = 0;
} elsif ($field =~ s/^(define(?:d)?block)(\s+)/$2/io) {
$keepname = 1;
$self->isBlock(1);
$blockrequest = 1;
} else {
$field =~ s/(\w+)(\s|$)/$2/io;
$keepname = 0;
$blockrequest = 0;
}
my ($defname, $defabstract_or_disc, $namedisc) = getAPINameAndDisc($field);
if ($self->isBlock()) {
print "ISBLOCK (BLOCKREQUEST=$blockrequest)\n" if ($localDebug);
if ($blockrequest) {
print "Added block name $defname\n" if ($localDebug);
$self->name($defname);
if (length($defabstract_or_disc)) {
if ($namedisc) {
$self->nameline_discussion($defabstract_or_disc);
} else {
$self->discussion($defabstract_or_disc);
}
}
} else {
print "Added block member $defname\n" if ($localDebug);
$self->attributelist("Included Defines", $field);
}
} else {
$self->name($defname);
if (length($defabstract_or_disc)) {
if ($namedisc) {
$self->nameline_discussion($defabstract_or_disc);
} else {
$self->discussion($defabstract_or_disc);
}
}
}
last SWITCH;
};
my $filename = $self->filename();
my $linenum = $self->linenum();
if (length($field)) { warn "$filename:$linenum: warning: Unknown field (\@$field) in #define comment (".$self->name().")\n"; }
}
}
}
sub setPDefineDeclaration {
my($self) = shift;
my ($dec) = @_;
my $localDebug = 0;
$self->declaration($dec);
my $filename = $self->filename();
my $line = $self->linenum();
print "============================================================================\n" if ($localDebug);
print "Raw #define declaration is: $dec\n" if ($localDebug);
$self->declarationInHTML($dec);
return $dec;
}
sub isBlock {
my $self = shift;
if (@_) {
$self->{ISBLOCK} = shift;
}
return $self->{ISBLOCK};
}
sub blockDiscussion {
my $self = shift;
if (@_) {
$self->{BLOCKDISCUSSION} = shift;
}
return $self->{BLOCKDISCUSSION};
}
sub result {
my $self = shift;
if (@_) {
$self->{RESULT} = shift;
}
return $self->{RESULT};
}
sub printObject {
my $self = shift;
print "#Define\n";
$self->SUPER::printObject();
print "Result: $self->{RESULT}\n";
print "\n";
}
sub parseTreeList
{
my $self = shift;
my $localDebug = 0;
if ($localDebug) {
print "OBJ ".$self->name().":\n";
foreach my $tree (@{$self->{PARSETREELIST}}) {
print "PARSE TREE: $tree\n";
}
}
return $self->{PARSETREELIST};
}
sub addParseTree
{
my $self = shift;
my $tree = shift;
push(@{$self->{PARSETREELIST}}, $tree);
}
sub parseTree
{
my $self = shift;
my $xmlmode = 0;
if ($self->outputformat eq "hdxml") {
$xmlmode = 1;
}
if (@_) {
my $treeref = shift;
$self->SUPER::parseTree($treeref);
my $tree = ${$treeref};
my ($success, $value) = $tree->getPTvalue();
if ($success) {
my $vstr = "";
if ($xmlmode) {
$vstr = sprintf("0x%x", $value)
} else {
$vstr = sprintf("0x%x (%d)", $value, $value)
}
if (!$self->isBlock) { $self->attribute("Value", $vstr, 0); }
}
return $treeref;
}
return $self->SUPER::parseTree();
}
sub parseOnly
{
my $self = shift;
if (@_) {
$self->{PARSEONLY} = shift;
}
return $self->{PARSEONLY};
}
sub free
{
my $self = shift;
$self->{PARSETREELIST} = ();
$self->SUPER::free();
}
1;