=head1 Plugin TreeVisualisation.pm

This plugin handles the following PBS defined switches:

=over 2

=item  --tt

=item --ttno

=back

And add the following functionality:

=over 2

=item --tnonh, removes header files from the tree dump

=item --tnonr, removes files matching the passed regex

=back

=cut

use PBS::PBSConfigSwitches ;
use PBS::Information ;
use Data::TreeDumper ;

#-------------------------------------------------------------------------------

my $no_header_files_display ;
my @display_filter_regexes ;

PBS::PBSConfigSwitches::RegisterFlagsAndHelp
	(
	  'tnonh'
	, \$no_header_files_display
	, "Do not display header files in the tree dump."
	, ''
	
	, 'tnonr=s'
	, \@display_filter_regexes 
	, "removes files matching the passed regex from the tree dump."
	, ''
	) ;
	
sub PostDependAndCheck
{
my ($pbs_config, $dependency_tree, $inserted_nodes) = @_ ;

#------------------
#  DTD filters,
#------------------
my $FilterDump;

if(defined $pbs_config->{DEBUG_DISPLAY_TREE_NAME_ONLY})
	{
	$FilterDump= sub #no private data
			{
			my ($tree) = @_ ;
			
			if('HASH' eq ref $tree)
				{
				my @keys_to_dump ;
				
				for(keys %$tree)
					{
					if(/^__/)
						{
						if
							(
							   (/^__BUILD_NAME$/  && defined $pbs_config->{DEBUG_DISPLAY_TREE_NAME_BUILD})
							|| (/^__TRIGGERED$/   && defined $pbs_config->{DEBUG_DISPLAY_TREE_NODE_TRIGGERED_REASON})
							|| (/^__DEPENDED_AT$/ && defined $pbs_config->{DEBUG_DISPLAY_TREE_DEPENDED_AT})
							|| (/^__INSERTED_AT$/ && defined $pbs_config->{DEBUG_DISPLAY_TREE_INSERTED_AT})
							#~ || /^__VIRTUAL/
							)
							{
							# display these
							}
						else
							{
							next ;
							}
						}
						
					# handle --tnonh
					if(/\.h$/ && $no_header_files_display)
						{
						next ;
						}
						
					# handle --tnonr
					my $excluded ;
					for my $regex (@display_filter_regexes)
						{
						if($_ =~ $regex)
							{
							$excluded++ ;
							last ;
							}
						}
					next if $excluded ;
					
					
					my $key_name = $_ ;
					if(defined $pbs_config->{DEBUG_DISPLAY_TREE_NODE_TRIGGERED})
						{
						if($key_name !~ /^__/)
							{
							if('HASH' eq ref $tree->{$key_name} && exists $tree->{$key_name}{__TRIGGERED})
								{
								$key_name = [$key_name, "* $key_name"] ;
								}
							}
						}
						
					push @keys_to_dump, $key_name ;
					}
				
				return('HASH', undef, sort {$a =~ /^__/ ? 1 : $b =~ /^__/ ? 1 : 0 } sort @keys_to_dump) ;
				}
				
			return (Data::TreeDumper::DefaultNodesToDisplay($tree)) ;
			} ;
	}
else
	{
	if(defined $pbs_config->{DEBUG_DISPLAY_TREE_DISPLAY_ALL_DATA})
		{
		$FilterDump = undef ;
		}
	else
		{
		$FilterDump = sub
			{
			# try to reduce tree dump to a minimal
			# undefined entries or entries pointing to empty structure are not displayed
			
			my ($tree, $level, $path, $nodes_to_display, $setup, $filter_argument) = @_ ;
			
			if('HASH' eq ref $tree)
				{
				my @keys_to_dump ;
				
				for (keys %$tree)
					{
					if(/^__/)
						{
						if
							(
							   (/^__PARENTS$/ && defined $pbs_config->{DEBUG_DISPLAY_TREE_NO_DEPENDENCIES})
							#~ || (/^__DEPENDENCY_TO/ && defined $pbs_config->{DEBUG_DISPLAY_TREE_NO_DEPENDENCIES})
							    #~ $_ eq '__VIRTUAL'
							)
							{
							next ;
							}
							
						push @keys_to_dump, $_ ;
						}
					else
						{
						# handle -tnd
						if($pbs_config->{DEBUG_DISPLAY_TREE_NO_DEPENDENCIES})
							{
							my $last_element = $setup->{__PATH_ELEMENTS}[-1] ;
							my $name = $last_element->[1] || '' ;
							
							if($name !~ /__/ && /^[^__]/ )
								{
								#~ PrintDebug "skipping $_\n" ;
								next ;
								}
							}
							
						# remove empty entries
						for my $reference_type (ref $tree->{$_})
							{
							'' eq $reference_type && do
								{
								push @keys_to_dump, $_ if defined $tree->{$_} ;
								last ;
								} ;
								
							'HASH' eq $reference_type && do
								{
								push @keys_to_dump, $_ unless 0 == keys %{$tree->{$_}} ;
								last ;
								} ;
								
							'ARRAY' eq $reference_type && do
								{
								push @keys_to_dump, $_ unless 0 == @{$tree->{$_}} ;
								last ;
								} ;
								
							push @keys_to_dump, $_ ;
							}
						}
					}
					
				return('HASH', undef, sort {$a =~ /^__/ ? 0 : $b =~ /^__/ ? 1 : 0 } sort @keys_to_dump) ;
				}
				
			return (Data::TreeDumper::DefaultNodesToDisplay($tree)) ;
			} ;
		}
	}
# end DTD filters.

if(defined $pbs_config->{DISPLAY_TEXT_TREE_USE_DHTML})
	{
	PrintInfo "Generating DHTML dump of the dependency tree in '$pbs_config->{DISPLAY_TEXT_TREE_USE_DHTML}' ...\n" ;
	
	open DHTML, '>', $pbs_config->{DISPLAY_TEXT_TREE_USE_DHTML} 
		or die "can't open dhtml file '$pbs_config->{DISPLAY_TEXT_TREE_USE_DHTML}': @!\n" ;
		
		
	print DHTML <<EOT;
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
     
<html>
EOT

	my $style ;
	my $body = DumpTree
			(
			  $dependency_tree
			, "Tree for $dependency_tree->{__NAME}:"
			, DISPLAY_ROOT_ADDRESS => 1
			#~ , DISPLAY_PERL_ADDRESS => 1
			, DISPLAY_PERL_SIZE => 1
			, FILTER =>$FilterDump
			
			, RENDERER => 
				{
				  NAME => 'DHTML'
				, STYLE => \$style
				, BUTTON =>
					{
					  COLLAPSE_EXPAND => 1
					, SEARCH => 1
					}
				}
			) ;
			
	print DHTML <<EOT;
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
>
     
<html>

<!--
Automatically generated by Data::TreeDumper::DHTML
-->

<head>
<title>Data</title>

$style
</head>
<body>
$body
</body>
</html>
EOT

	close(DHTML) ;
	}

if(defined $pbs_config->{DEBUG_DISPLAY_TEXT_TREE})
	{
	my ($tree_to_display, $dump_title) ;
	
	if('' eq $pbs_config->{DEBUG_DISPLAY_TEXT_TREE})
		{
		($tree_to_display, $dump_title) = ($dependency_tree, , "Tree for '$dependency_tree->{__NAME}':") ;
		}
	else
		{
		if(exists $inserted_nodes->{$pbs_config->{DEBUG_DISPLAY_TEXT_TREE}})
			{
			($tree_to_display, $dump_title) = 
				(
				  $inserted_nodes->{$pbs_config->{DEBUG_DISPLAY_TEXT_TREE}}
				, "Tree for '$pbs_config->{DEBUG_DISPLAY_TEXT_TREE}':"
				) ;
			}
		else
			{
			my $local_name = './' . $pbs_config->{DEBUG_DISPLAY_TEXT_TREE} ;
			
			if(exists $inserted_nodes->{$local_name})
				{
				($tree_to_display, $dump_title) = ($inserted_nodes->{$local_name}, "Tree for '$local_name':") ;
				}
			else
				{
				PrintWarning("Display text tree: No such element '$pbs_config->{DEBUG_DISPLAY_TEXT_TREE}'\n") ;
				DisplayCloseMatches($pbs_config->{DEBUG_DISPLAY_TEXT_TREE}, $inserted_nodes) ;
				}
			}
		}
		
	# find the inserted roots
	for my $node_name (keys %$inserted_nodes)
		{
		if(exists $inserted_nodes->{$node_name}{__TRIGGER_INSERTED})
			{
			$tree_to_display->{"$node_name (triggered by '$inserted_nodes->{$node_name}{__TRIGGER_INSERTED}') "} =  $inserted_nodes->{$node_name} ;
			}
		}
			
	PrintInfo DumpTree($tree_to_display, $dump_title, FILTER => $FilterDump) if defined $tree_to_display ;
	}
}

#-------------------------------------------------------------------------------

1 ;