package HeaderDoc::PDefine;
use HeaderDoc::Utilities qw(findRelativePath safeName getAPINameAndDisc convertCharsForFileMaker printArray printHash);
use HeaderDoc::HeaderElement;
@ISA = qw( HeaderDoc::HeaderElement );
use strict;
use vars qw($VERSION @ISA);
$VERSION = '1.20';
sub processPDefineComment {
my($self) = shift;
my $fieldArrayRef = shift;
my @fields = @$fieldArrayRef;
foreach my $field (@fields) {
chomp($field);
SWITCH: {
($field =~ /^\/\*\!/)&& do {last SWITCH;}; ($field =~ s/^define(d)?\s+//) && do {$self->name($field); 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;};
my $filename = $HeaderDoc::headerObject->name();
print "$filename:0:Unknown field: $field\n";
}
}
}
sub setPDefineDeclaration {
my($self) = shift;
my ($dec) = @_;
my $localDebug = 0;
print "============================================================================\n" if ($localDebug);
print "Raw #define declaration is: $dec\n" if ($localDebug);
$dec =~ s/^\s+//;
$dec =~ s/\t/ /g;
$dec =~ s/</</g;
$dec =~ s/>/>/g;
if (length ($dec)) {$dec = "<pre>\n$dec</pre>\n";};
print "#define: returning declaration:\n\t|$dec|\n" if ($localDebug);
print "============================================================================\n" if ($localDebug);
$self->declarationInHTML($dec);
return $dec;
}
sub documentationBlock {
my $self = shift;
my $name = $self->name();
my $desc = $self->discussion();
my $declaration = $self->declarationInHTML();
my $abstract = $self->abstract();
my $updated = $self->updated();
my $contentString;
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";
return $contentString;
}
sub XMLdocumentationBlock {
my $self = shift;
my $name = $self->name();
my $desc = $self->discussion();
my $declaration = $self->declarationInHTML();
my $abstract = $self->abstract();
my $updated = $self->updated();
my $contentString;
$contentString .= "<define 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";
$contentString .= "</define>\n";
return $contentString;
}
sub printObject {
my $self = shift;
print "#Define\n";
$self->SUPER::printObject();
print "\n";
}
1;