src/BuildSystem/ToolParser.pm

#____________________________________________________________________ 
# File: ToolParser.pm
#____________________________________________________________________ 
#  
# Author: Shaun Ashby <Shaun.Ashby@cern.ch>
# Update: 2004-02-09 20:14:55+0100
# Revision: $Id: ToolParser.pm,v 1.5.4.6 2007/12/13 14:35:44 muzaffar Exp $ 
#
# Copyright: 2004 (C) Shaun Ashby
#
#--------------------------------------------------------------------
package BuildSystem::ToolParser;
require 5.004;

use Exporter;
use SCRAM::MsgLog;
use ActiveDoc::SimpleDoc;
use Utilities::Verbose;

@ISA=qw(Exporter Utilities::Verbose);
@EXPORT=qw();

#
sub new
   ###############################################################
   # new                                                         #
   ###############################################################
   # modified : Thu Nov 13 10:42:08 2003 / SFA                   #
   # params   :                                                  #
   #          :                                                  #
   # function :                                                  #
   #          :                                                  #
   ###############################################################
   {
   my $proto=shift;
   my $class=ref($proto) || $proto;
   $self={};
   
   bless $self,$class;
   
   $self->{cache}=shift;
   $self->{mydoctype}="BuildSystem::ToolParser";
   $self->{mydocversion}="1.1";
   $self->{interactive} = 0;
   $self->{content} = {};
   $self->{nested} = 0;
   $self->{scramdoc}=ActiveDoc::SimpleDoc->new();
   $self->{scramdoc}->newparse("setup", $self->{mydoctype},'Subs');

   return $self;
   }

### Tag handler methods ###
sub tool()
   {
   my ($object,$name,%attributes)=@_;
   my $hashref = \%attributes;   
   # A way to distinguish the naming of different nested levels:
   $self->{levels}=['','tag','nexttag'];
   $$hashref{'name'} =~ tr[A-Z][a-z];

   # Make sure we only pick up the tool requested:
   if ( ($self->{tool} eq $$hashref{'name'}) && 
        ($self->{version} eq $$hashref{'version'} ))
      {
      # These variables will be used when expanding settings
      # in tool variable defs:
      $ENV{SCRAMToolname} = $$hashref{'name'};
      $ENV{SCRAMToolversion} = $$hashref{'version'};
      $self->{content}->{TOOLNAME}=$$hashref{'name'};
      $self->{content}->{TOOLVERSION}=$$hashref{'version'};
      }
   else
      {
      print "\n";
      $::scram->scramerror("Configuration problem! Wanted/actual ".$self->{tool}." tool versions differ (wanted = ".$self->{version}.", downloaded = ".$$hashref{'version'}.")\n");
      }
   
   # Test to see if this doc defines a
   # scram-managed project or a compiler:
   if (exists ($$hashref{'type'}))
      {
      $$hashref{'type'} =~ tr[A-Z][a-z];
      $self->{content}->{SCRAM_PROJECT} = 0;

      if ($$hashref{'type'} eq 'scram')
         {
         $self->{content}->{SCRAM_PROJECT} = 1;
         }     
      elsif ($$hashref{'type'} eq 'compiler')
         {
         # Is tool a compiler? Store this for retrieval from tool manager obj:
         $self->{content}->{SCRAM_COMPILER} = 1;
         }
      else
         {
         $::scram->scramwarn("Unknown type \"".$$hashref{'type'}."\" in tool ".$$hashref{'name'}."\n");
         }
      }
   }

sub tool_()
   {
   delete $self->{levels};
   delete $self->{id};
   delete $self->{nested};
   }

sub lib()
   {
   my ($object,$name,%attributes)=@_;
   push(@{$self->{"$self->{levels}->[$self->{nested}]".content}->{LIB}},$attributes{'name'});   
   }

sub info()
   {
   my ($object,$name,%attributes)=@_;
   $self->{"$self->{levels}->[$self->{nested}]".content}->{INFO} = \%attributes;
   }

sub use()
   {
   my ($object,$name,%attributes)=@_;
   push(@{$self->{"$self->{levels}->[$self->{nested}]".content}->{USE}},$attributes{'name'});
   }

sub runtime()
   {
   my ($object,$name,%attributes)=@_;
   my $hashref = \%attributes;   
   my $envname;
   # Break the value/default value into its constituent parts:
   foreach my $t (qw(value default))
      {
      if (exists ($$hashref{$t}))
         {
         $hashref->{ELEMENTS} = [];
         map
            {
            # In some cases, we might set a runtime path (e.g. LD_LIBRARY_PATH) to
            # a proper path value i.e. X:Y. In this case, don't bother adding the string
            # as a "variable" to ELEMENTS:
            if ($_ =~ m|\$(.*)?| && $_ !~ /:/) 
               {
               push(@{$hashref->{ELEMENTS}},$1);
               }
            } split("/",$hashref->{$t});
         }
      }
   
   # Check to see if we have a "type" arg. If so, we use this to create the key:
   if (exists ($hashref->{'type'}))
      {
      my $type=$hashref->{'type'};
      # Make the type uppercase:
      $type =~ tr/[a-z]/[A-Z]/;
      # Rename the environment as "<type>:<env name>":
      $envname = $type.":".$$hashref{'name'};
      }
   else
      {
      $envname = $$hashref{'name'};
      }
   
   # Delete name entry so hash is more tidy
   delete $$hashref{'name'};
   
   # Before we save $hashref we need to know if there are already
   # any runtime tags with the same name. If there are, we must save all
   # data to an aray of hashes:
   if (exists ($self->{"$self->{levels}->[$self->{nested}]".content}->{RUNTIME}->{$envname}))
      {
      push(@{$self->{"$self->{levels}->[$self->{nested}]".content}->{RUNTIME}->{$envname}},$hashref);
      }
   else
      {
      # No entry yet so just store the hashref:
      $self->{"$self->{levels}->[$self->{nested}]".content}->{RUNTIME}->{$envname} = [ $hashref ];
      }   
   }

sub flags()
   {
   my ($object,$name,%attributes)=@_;
   # Extract the flag name and its value:
   my ($flagname,$flagvaluestring) = each %attributes;
   $flagname =~ tr/[a-z]/[A-Z]/; # Keep flag name uppercase
   chomp($flagvaluestring);
   # Split the value on whitespace so we can push all
   # individual flags into an array:
   my @flagvalues = split(' ',$flagvaluestring);
   
   # Is current tag within another tag block?
   if ($self->{nested} > 0)
      {
      # Check to see if the current flag name is already stored in the hash. If so,
      # just add the new values to the array of flag values:
      if (exists ($self->{"$self->{levels}->[$self->{nested}]".content}->{FLAGS}->{$flagname}))
         {
         push(@{$self->{"$self->{levels}->[$self->{nested}]".content}->{FLAGS}->{$flagname}},@flagvalues);
         }
      else
         {
         $self->{"$self->{levels}->[$self->{nested}]".content}->{FLAGS}->{$flagname} = [ @flagvalues ];
         }
      }
   else
      {
      if (exists ($self->{content}->{FLAGS}->{$flagname}))
         {
         push(@{$self->{content}->{FLAGS}->{$flagname}},@flagvalues);
         }
      else
         {
         $self->{content}->{FLAGS}->{$flagname} = [ @flagvalues ];
         }
      }
   }

sub client()
   {
   $self->pushlevel();
   }

sub client_()
   {
   if ($self->{isarch} == 1)
      {
      # If we already have an architecture tag, we must write to tagcontent hash:
      $self->{tagcontent}->{CLIENT}=$self->{nexttagcontent};
      delete $self->{nexttagcontent};
      }
   else
      {
      $self->{content}->{CLIENT}=$self->{tagcontent};
      }
   
   $self->poplevel();
   }

sub environment()
   {
   my ($object,$name,%attributes)=@_;
   my $hashref = \%attributes;
   # Save a copy of the name of this environment:
   my $envname=$$hashref{'name'};
   delete $$hashref{'name'}; # Delete name entry so hash is more tidy
   # Break the value/default value into its constituent parts:
   foreach my $t (qw(value default))
      {
      if (exists ($$hashref{$t}))
         {
         $hashref->{ELEMENTS} = [];
         map
            {
            if ($_ =~ m|\$(.*)?|)
               {
               push(@{$hashref->{ELEMENTS}},$1);
               }
            } split("/",$hashref->{$t});
         }
      }
   
   # Before we save $hashref we need to know if there are already
   # any env tags with the same name. If there are, we must save all
   # data to an aray of hashes:
   if (exists ($self->{"$self->{levels}->[$self->{nested}]".content}->{ENVIRONMENT}->{$envname}))
      {
      push(@{$self->{"$self->{levels}->[$self->{nested}]".content}->{ENVIRONMENT}->{$envname}},$hashref);
      }
   else
      {
      # No entry yet so just store the hashref:
      $self->{"$self->{levels}->[$self->{nested}]".content}->{ENVIRONMENT}->{$envname} = [ $hashref ];
      }
   }

sub makefile()
   {
   my ($object,$name,%attributes)=@_;
   # Set our own Char handler so we can collect the content
   # of the Makefile tag:
   $object->setHandlers(Char => \&makefile_content);
   $self->{makefilecontent} = [];
   }

sub makefile_content()
   {
   my ($object, @strings) = @_;
   push(@{$self->{makefilecontent}},@strings);
   }

sub makefile_()
   {
   my ($object,$name)=@_;
   push(@{$self->{"$self->{levels}->[$self->{nested}]".content}->{MAKEFILE}},
        join('',@{$self->{makefilecontent}}));
   delete $self->{makefilecontent};
   # Unset the Char handler to revert to the default behaviour:
   $object->setHandlers(Char => 0);
   }

sub architecture()
   {
   my ($object,$name,%attributes)=@_;
   $self->pushlevel(\%attributes,1); # Set nested to 1;
   }

sub architecture_()
   {
   # Need to be able to cope with multiple arch blocks with same arch string:
   if (exists ($self->{content}->{ARCH}->{$self->{id}->{'name'}}))
      {
      # Already have an architecture tag for this arch:
      while (my ($k,$v) = each %{$self->{tagcontent}})
         {
         # If this tag (e.g. LIB, USE, MAKEFILE) already exists and (as we know
         # it should be) its data is an ARRAY, push it to the store:
         if (exists ($self->{content}->{ARCH}->{$self->{id}->{'name'}}->{$k}) && 
             ref($v) eq 'ARRAY')
            {
            push(@{$self->{content}->{ARCH}->{$self->{id}->{'name'}}->{$k}},@$v);
            }
         else
            {
            # Otherwise (for HASH data) we just store it. Note that, because we do
            # not loop over the HASH content and check for already existsing keys,
            # if two arch blocks with same arch name define the same tag (e.g, ENV),
            # the last occurrence will be kept (i.e. the two values won't be added
            # to one ENV hash: //FIXME for later....)
            $self->{content}->{ARCH}->{$self->{id}->{'name'}}->{$k} = $v;
            }
         }
      }
   else
      {
      $self->{content}->{ARCH}->{$self->{id}->{'name'}}=$self->{tagcontent};
      }
   
   delete $self->{isarch};
   $self->poplevel();
   }
         
sub parse
   {
   my $self=shift;
   my ($tool,$toolver,$file)=@_;   
   $self->{tool}=$tool;
   $self->{version}=$toolver;
   $self->{scramdoc}->filetoparse($file);   
   $self->verbose("Setup Parse");
   my $fhead='<?xml version="1.0" encoding="UTF-8" standalone="yes"?><doc type="BuildSystem/ToolParser" version="1.0">';
   my $ftail='</doc>';
   $self->{scramdoc}->parse("setup",$fhead,$ftail);
   delete $self->{scramdoc};
   return $self;
   }

sub pushlevel
   {
   my $self = shift;
   my ($info, $nextlevel)=@_;
   
   $self->{id} = $info if (defined $info);

   # Check to see if last tag was arch: if so, ceate new level:
   if ($self->{isarch} == 1)
      {
      $self->{nested} = 2;
      $self->{nexttagcontent}={};
      }
   else
      {
      $self->{nested} = 1;
      $self->{tagcontent}={};
      }

   # Set something which says "last starter tag was ARCH":
   if ($nextlevel)
      {
      $self->{isarch} = 1;
      }
   }

sub poplevel
   {
   my $self = shift;
   
   # Drop level of nesting by one:
   $self->{nested}--;

   if ($self->{isarch} != 1)
      {
      delete $self->{tagcontent};
      }
   }

sub rmenvdata
   {
   my $self=shift;
   delete $self->{ENVDATA};
   }

###################################
##      Data Access Methods      ##
###################################
sub toolname
   {
   my $self=shift;
   # Return tool name:
   return ($self->{content}->{TOOLNAME});
   }

sub toolversion
   {
   my $self=shift;
   # Return tool version:
   return ($self->{content}->{TOOLVERSION});
   }

sub toolcontent
   {
   my $self=shift;
   # Return whole of content hash:
   return $self->{content};
   }

sub getrawdata()
   {
   my $self=shift;
   my ($tagtype)=@_;
   
   # Check to see if we have data for this tag:
   if (! exists ($self->{content}->{$tagtype}))
      {
      # If not, return:
      return 0;
      }
   
   # Check the number of keys for hash referred to by this object.
   # If 0, return:
   if (ref($self->{content}->{$tagtype}) eq 'HASH') # 
      {
      if ((my $nkeys=keys %{$self->{content}->{$tagtype}}) > 0)
         {
         # Return the data for the tag $tagtype. ARCH is a bit special because
         # we want the data for the actual arch (thus, data is on a different level):
         if ($tagtype eq 'ARCH')
            {
            my $archmatch = {};
            # Check for matching arch key and return hash of relevant data.
            # Also must take into account the fact that several arch names may match, e.g. Linux, Linux__2 and
            # Linux__2.4 all match. If we find more than one match, collect ALL matching data and return it:
            while (my ($k,$v) = each %{$self->{content}->{ARCH}})
               {
               # For every matching architecture we snatch the data and squirrel it away:
               if ( $ENV{SCRAM_ARCH} =~ /$k.*/ )
                  {
                  # Now we check the tags inside the arch block. Note that we do not want to descend
                  # into CLIENT tags, if these exist. We just want to return all data in the ARCH 
                  # block while making sure that multiple matches are handled correctly. We assume that
                  # you will only find one CLIENT block inside and ARCH:
                  while (my ($matchtag, $matchval) = each %{$v})
                     {
                     if ($matchtag =~ /CLIENT|FLAGS|RUNTIME/)
                        {
                        $archmatch->{$matchtag} = $matchval;
                        }
                     else
                        {
                        # Treat tags differently according to whether they are HASHes or ARRAYs:
                        if (ref($matchval) =~ /HASH/)
                           {
                           while (my ($t, $val) = each %{$matchval})
                              {
                              if (exists ($archmatch->{$matchtag}->{$t}))
                                 {
                                 push(@{$archmatch->{$matchtag}->{$t}},@$val);
                                 }
                              else
                                 {
                                 $archmatch->{$matchtag}->{$t} = $val;
                                 }
                              }
                           }
                        else # Here we deal with arrays:
                           {                       
                           if (exists ($archmatch->{$matchtag}))
                              {
                              push(@{$archmatch->{$matchtag}},@$matchval);
                              }
                           else
                              {
                              $archmatch->{$matchtag} = $matchval;
                              }                                            
                           }
                        }
                     }
                  }
               }
            # Return the squirrel:
            return $archmatch;
            
            } # End of ARCH tag treatment
         else
            {
            # Return other tag data:
            return $self->{content}->{$tagtype};
            }
         }
      else
         {
         print "Warning: $tagtype tags contain no other tag data!","\n";
         return undef;
         }
      }
   else
      {
      # We have an array of data or a scalar:
      return $self->{content}->{$tagtype}; 
      }
   }

sub processrawtool()
   {
   my $self=shift;
   my ($interactive) = @_;
   my $data = [];
   my $environments = {}; # Somewhere to collect our environments

   # Set interactive mode if required:
   $self->{interactive} = $interactive;

   # Somewhere to store the data:
   use BuildSystem::ToolData;
   my $tooldataobj = BuildSystem::ToolData->new();
   
   # Set the name and version:
   $tooldataobj->toolname($self->toolname());
   $tooldataobj->toolversion($self->toolversion());
   
   # First, collect all tag data so that we only have non-nested tags.
   # Check for architecture-dependent data first, followed by client tags:
   foreach $nested_tag (qw( ARCH CLIENT ))
      {
      if (my $thisdata=$self->getrawdata($nested_tag))
         {
         foreach my $item (keys %{ $thisdata })
            {
            if ($item eq 'CLIENT')
               {
               my $clientdata = $thisdata->{$item};
               foreach my $ckey (keys %{$clientdata})
                  {
                  $environments->{$ckey} = $clientdata->{$ckey};
                  }
               }
            elsif ($item eq 'ENVIRONMENT' || $item eq 'RUNTIME')
               {
               # Check to see if tag already exists before saving:
               if (exists($environments->{$item}))
                  {
                  foreach my $ek (keys %{$thisdata})
                     {
                     if (exists($environments->{$item}->{$ek}))
                        {
                        push(@{$environments->{$item}->{$ek}}, @{$thisdata->{$item}->{$ek}});
                        }
                     else
                        {
                        $environments->{$item}->{$ek} = $thisdata->{$item}->{$ek};
                        }              
                     }
                  }
               else
                  {
                  # There isn't an entry yet:
                  $environments->{$item} = $thisdata->{$item};
                  }
               }
            else
               {
               my $data = $thisdata->{$item};
               
               if (ref($data) eq 'HASH')
                  {
                  while (my ($f,$v) = each %$data)
                     {
                     $tooldataobj->flags($f,$v);
                     }
                  }
               else
                  {
                  my $subname = lc($item);
                  $tooldataobj->$subname($data), if ($#$data != -1);
                  }
               }
            }
         }
      else
         {
         # No entry for this nested tag. Proceed.
         next;
         }
      }
   # Now handle all other normal tags:
   foreach my $normal_tag (qw( ENVIRONMENT RUNTIME )) 
      {
      # Do we have some data for this tag?
      if (my $thisdata=$self->getrawdata($normal_tag))
         {
         # Add the data to our environments hash. We must check to see if
         # there is an entry already:
         if (exists($environments->{$normal_tag}))
            {
            foreach my $ek (keys %{$thisdata})
               {
               if (exists($environments->{$normal_tag}->{$ek}))
                  {
                  push(@{$environments->{$normal_tag}->{$ek}}, @{$thisdata->{$normal_tag}->{$ek}});
                  }
               else
                  {
                  $environments->{$normal_tag}->{$ek} = $thisdata->{$normal_tag}->{$ek};
                  }
               }
            }
         else
            {
            # There isn't an entry yet:
            $environments->{$normal_tag} = $thisdata;
            }
         }
      else
         {
         # No data so proceed:
         next;
         }
      }

   # Finally, tags that can be stored straight away:
   foreach my $tag (qw( FLAGS MAKEFILE ))
      {
      my $bdata = $self->getrawdata($tag);
      if (ref($bdata) eq 'HASH')
         {
         while (my ($f,$v) = each %$bdata)
            {
            $tooldataobj->flags($f,$v);
            }
         }
      else
         {
         $tooldataobj->makefile($bdata), if ($#$bdata != -1);   
         }
      }

   # Libs and tool dependencise:
   foreach my $tag (qw( LIB USE ))
      {
      my $bdata = $self->getrawdata($tag);
      my $subname = lc($tag);
      $tooldataobj->$subname($bdata), if ($#$bdata != -1);
      }

   # Also check to see if this tool is a scram-managed project. If
   # so, set the SCRAM_PROJECT variable in the ToolData object:
   if (exists ($self->{content}->{SCRAM_PROJECT}))
      {
      $tooldataobj->scram_project($self->{content}->{SCRAM_PROJECT});
      }
   
   # And check to see if this tool is a compiler. If so, set
   # the SCRAM_COMPILER variable in the ToolData object:
   if (exists ($self->{content}->{SCRAM_COMPILER}))
      {
      $tooldataobj->scram_compiler($self->{content}->{SCRAM_COMPILER});
      }

   # Establish the order of parsing the value strings:
   my $order = $self->process_environments($environments);
   if ($self->{interactive})
      {
      # Set the values interactively:
      $self->interactively_find_settings($tooldataobj, $environments, $order);
      }
   else
      {
      # Set the values:
      $self->find_settings($tooldataobj, $environments, $order);
      }
     
   # Return a ToolData object:
   return $tooldataobj;
   }

sub process_environments()
   {
   my $self=shift;
   my ($environments)=@_;
   
   use BuildSystem::SCRAMGrapher;
   my $G = BuildSystem::SCRAMGrapher->new();

   foreach $envtype (keys %{$environments})
      {
      while (my ($envcontent,$envdata) = each %{$environments->{$envtype}})
         {
         # Add a vertex for the VARIABLE name:
         $G->vertex($envcontent);

         foreach my $element (@$envdata)
            {
            if (exists($element->{'ELEMENTS'}))
               {
               map
                  {
                  # Add a path for each element in ELEMENTS:
                  $G->edge($envcontent, $_);
                  } @{$element->{'ELEMENTS'}};
               }
            }
         }
      }

   my $setup_order = $G->sort();
   return $setup_order;
   }

sub find_settings()
   {
   my $self=shift;
   my ($tooldataobj, $environments, $ordering)=@_;
   my $stringtoeval;
   my $runtime=[];
   my $path;
   
   use BuildSystem::ToolSettingValidator;
   
   my $tsv = BuildSystem::ToolSettingValidator->new($environments, $self->toolname());
   
   foreach my $envname (@$ordering)
      {
      my $type = 'ENVIRONMENT';
      my $envdata = $tsv->environment($type, $envname);

      # Handle single-occurrence variables first (i.e. VAR appears once
      # in array of hashes):
      if ($envdata != 0 && $#$envdata == 0) # One element only!
         {
         scramlogmsg("\nFinding a value for $envname:","\n\n");
         # We have an environment and only one data element:
         # Check the lookup DB:
         if ($tsv->checkDB($envname))
            {
            scramlogmsg("\tValidating value for $envname (found in tool DB):","\n");
            if ($tsv->validatepath())
               {
               # Save in TSV and store in ToolData object:
               $tsv->savevalue($envname,$tsv->pathfromdb());
               $self->store($tooldataobj, $envname, $tsv->pathfromdb());
               }
            else
               {
               $path = $tsv->findvalue($envname, $envdata);                    
               # Save the value in ToolData object:
               $self->store($tooldataobj, $envname, $path);            
               }
            }
         else
            {
            $path = $tsv->findvalue($envname, $envdata);                       
            # Save in ToolData object:
            $self->store($tooldataobj, $envname, $path);
            }
         }
      elsif ($envdata != 0 && $#$envdata > 0)
         {
         scramlogmsg("\nFinding a value for $envname:","\n\n");
         foreach my $elementdata (@$envdata)
            {
            $path = $tsv->findvalue($envname, $elementdata);                
            # Save in ToolData object:
            $self->store($tooldataobj, $envname, $path);            
            }
         }
      elsif (exists($ENV{$envname}))
         {
         # Nothing to do here:
         push(@$runtime, $envname); # FIX From Shahzad.
         next;
         }
      else
         {
         push(@$runtime, $envname);
         }
      }
   # Check that the required libraries exist:
   $self->_lib_validate($tooldataobj);
   # Now process the runtime settings:
   scramlogmsg("\n-------------------------------\n");
   foreach my $rtname (@$runtime)
      {
      my $type = 'RUNTIME';      
      my $envdata = $tsv->environment($type, $rtname);
      my ($rttype,$realrtname) = split(':',$rtname);      
      
      # Only validate paths:
      if ($rtname =~ /:/)
         {      
         # Handle single-occurrence variables first (i.e. VAR appears once
         # in array of hashes):
         if ($envdata != 0 && $#$envdata == 0) # One element only!
            {
            scramlogmsg("\nRuntime path settings for $realrtname:","\n\n");
            # We have an environment and only one data element:
            # Check the lookup DB:
            if ($tsv->checkDB($rtname))
               {
               scramlogmsg("\tValidating value for path $realrtname (found in tool DB):","\n");
               if ($tsv->validatepath())
                  {
                  # Save in TSV and store in ToolData object:
                  $tsv->savevalue($rtname, $tsv->pathfromdb());
                  $tooldataobj->runtime($rtname, [ $tsv->pathfromdb() ]);
                  }
               else
                  {
                  $path = $tsv->findvalue($rtname, $envdata);                  
                  # Save the value in ToolData object:
                  $tooldataobj->runtime($rtname, [ $path ]);
                  }
               }
            else
               {
               $path = $tsv->findvalue($rtname, $envdata);                     
               # Save in ToolData object:
               $tooldataobj->runtime($rtname, [ $path ]);
               }
            }
         elsif ($envdata != 0 && $#$envdata > 0)
            {
            scramlogmsg("\nRuntime path settings for $realrtname:","\n\n");
            foreach my $elementdata (@$envdata)
               {
               $path = $tsv->findvalue($rtname, $elementdata);              
               # Save in ToolData object:
               $tooldataobj->runtime($rtname, [ $path ]);
               }
            }
         else
            {
            next;
            }
         }
      else
         {
         # Handle runtime variables:
         if ($envdata != 0 && $#$envdata == 0) # One element only!
            {
            my $value='';
            $tsv->checkdefaults($envdata, \$value);
            scramlogmsg("\n");
            
            # Chck to see if the value contains a variable that should be evaluated:
            if ($value =~ /$/)
               {
               # If so, find the value and substitute. This should work for all
               # occurrences of variables because by this point (and because the ordering
               # was established at the start) all other variables will have real values:
               my $dvalue = $tsv->_expandvars($value);
               $value = $dvalue;
               }
            
            scramlogmsg("Runtime variable ",$rtname," set to \"",$value,"\"\n");
            
            # Store the variable setting:
            $tooldataobj->runtime($rtname, [ $value ]);
            }
         else
            {
            next;
            }
         }
      }
   
   scramlogmsg("\n");
   }

sub interactively_find_settings()
   {
   my $self=shift;
   my ($tooldataobj, $environments, $ordering)=@_;
   my $stringtoeval;
   my $runtime=[];
   my ($path, $dpath);
   
   use BuildSystem::ToolSettingValidator;
   
   my $tsv = BuildSystem::ToolSettingValidator->new($environments, $self->toolname(), $self->{interactive});
   
   foreach my $envname (@$ordering)
      {
      my $type = 'ENVIRONMENT';
      my $envdata = $tsv->environment($type, $envname);

      # Handle single-occurrence variables first (i.e. VAR appears once
      # in array of hashes):
      if ($envdata != 0 && $#$envdata == 0) # One element only!
         {
         print "\nFinding a value for $envname:","\n";
         print "\n";
         # We have an environment and only one data element:
         # Check the lookup DB:
         if ($tsv->checkDB($envname))
            {
            print "\tValidating value for $envname (found in tool DB):","\n";
            if ($tsv->validatepath())
               {
               # This is our default:
               $dpath = $tsv->pathfromdb();
               # Run promptuser() to see if this value can be kept
               # or should be changed:
               $path = $tsv->promptuser($envname, $dpath); 
               # Save in TSV and store in ToolData object:
               $tsv->savevalue($envname,$path);
               $self->store($tooldataobj, $envname, $path);
               }
            else
               {
               $path = $tsv->ifindvalue($envname, $envdata);
               # Save the value in ToolData object:
               $self->store($tooldataobj, $envname, $path);
               }
            }
         else
            {
            $dpath = $tsv->ifindvalue($envname, $envdata);
            # Save in ToolData object:
            $self->store($tooldataobj, $envname, $dpath);
            }
         }
      elsif ($envdata != 0 && $#$envdata > 0)
         {
         print "\nFinding a value for $envname:","\n";
         print "\n";
         foreach my $elementdata (@$envdata)
            {
            $path = $tsv->ifindvalue($envname, $elementdata);
            # Save in ToolData object:
            $self->store($tooldataobj, $envname, $path);            
            }
         }
      elsif (exists($ENV{$envname}))
         {
         # Nothing to do here:
         next;
         }
      else
         {
         push(@$runtime, $envname);
         }
      }
   
   # Check that the required libraries exist:
   $self->_lib_validate($tooldataobj);
   
   # Now process the runtime settings:
   print "\n";
   print "-------------------------------\n";
   foreach my $rtname (@$runtime)
      {
      my $type = 'RUNTIME';      
      my $envdata = $tsv->environment($type, $rtname);
      my ($rttype,$realrtname) = split(':',$rtname);      
      
      # Only validate paths:
      if ($rtname =~ /:/)
         {      
         # Handle single-occurrence variables first (i.e. VAR appears once
         # in array of hashes):
         if ($envdata != 0 && $#$envdata == 0) # One element only!
            {
            print "\nRuntime path settings for $realrtname:","\n";
            print "\n";
            # We have an environment and only one data element:
            # Check the lookup DB:
            if ($tsv->checkDB($rtname))
               {
               print "\tValidating value for path $realrtname (found in tool DB):","\n";
               if ($tsv->validatepath())
                  {
                  $dpath = $tsv->pathfromdb();
                  # Run promptuser() to see if this value can be kept
                  # or should be changed:
                  $path = $tsv->promptuser($rtname, $dpath);              
                  # Save in TSV and store in ToolData object:
                  $tsv->savevalue($rtname, $path);
                  $tooldataobj->runtime($rtname, [ $path ]);
                  }
               else
                  {
                  $dpath = $tsv->ifindvalue($rtname, $envdata);
                  # Save the value in ToolData object:
                  $tooldataobj->runtime($rtname, [ $path ]);
                  }
               }
            else
               {
               $path = $tsv->ifindvalue($rtname, $envdata);
               # Save in ToolData object:
               $tooldataobj->runtime($rtname, [ $path ]);
               }
            }
         elsif ($envdata != 0 && $#$envdata > 0)
            {
            print "\nRuntime path settings for $realrtname:","\n";
            print "\n";
            foreach my $elementdata (@$envdata)
               {
               $path = $tsv->ifindvalue($rtname, $elementdata);
               # Save in ToolData object:
               $tooldataobj->runtime($rtname, [ $path ]);
               }
            }
         else
            {
            next;
            }
         }
      else
         {
         # Handle runtime variables:
         if ($envdata != 0 && $#$envdata == 0) # One element only!
            {
            my $dvalue='';
            $tsv->checkdefaults($envdata, \$dvalue);
            print "\n";
            my $value = $tsv->promptuserforvar($rtname, $dvalue);
            # Store the variable setting:
            $tooldataobj->runtime($rtname, [ $value ]);
            }
         else
            {
            next;
            }
         }
      }
   
   print "\n";
   }

sub store()
   {
   my $self=shift;
   my ($tooldataobj, $envname, $path) = @_;
   my $subrtn = lc($envname);
   
   if ($tooldataobj->can($subrtn))
      {
      $tooldataobj->$subrtn([ $path ]);
      }
   else
      {
      $tooldataobj->variable_data($envname, $path);
      }
   }

sub _lib_validate()
   {
   my $self=shift;
   my ($toolobj)=@_;
   my $errorstatus = { 0 => $main::good."[OK]".$main::normal, 1 => $main::error."[ERROR]".$main::normal };
   my $libsfound={};
      
   # Firstly, we check to see if there are libraries provided by this tool:
   my @libraries = $toolobj->lib();
   my @libpaths = $toolobj->libdir();
   
   foreach my $ldir (@libpaths)
      {
      my $full_libname_glob="lib".$lib."*.*";
      # Change to lib dir so we avoid the very long paths in our glob:
      chdir($ldir);
      # Next we use a glob to get libs matching this string (so we
      # can see if there's a shared or archive lib):
      my @possible_libs = glob($full_libname_glob);
      # 
      map
         {
         $_ =~ s/\.so*|\.a*//g; # Remove all endings
         # Store in our hash of found libs:
         $libsfound->{$_} = 1;
         } @possible_libs;
      }
   
   # Next we iterate over the list of libraries in our tool and
   # see if it was found in one of the libdirs:
   scramlogmsg("\n\n"), if ($#libraries != -1);
   foreach my $library (@libraries)
      {
      # Good status:
      my $errorid = 0;
      if (! exists ($libsfound->{'lib'.$library}))
         {
         # Check in system library dirs:
         if ($self->_check_system_libs($library))
            {
            $errorid = 0;
            }
         else
            {
            $errorid = 1; 
            }
         }
      scramlogmsg(sprintf("* Library check %-10s for lib%-12s\n",$errorstatus->{$errorid}, $library));
      }
   
   scramlogmsg("\n");
   }

sub _check_system_libs()
   {
   my $self=shift;
   my ($lib)=@_;
   my $libsfound = {};
   my $systemdirs = [ qw( /lib /usr/lib /usr/local/lib /usr/X11R6/lib ) ];
   my $full_libname_glob="lib".$lib."*.*";
   my $found = 0;
   
   foreach my $dir (@$systemdirs)
      {
      # Change to lib dir so we avoid the very long paths in our glob:
      chdir($dir);
      # Next we use a glob to get libs matching this string (so we
      # can see if there's a shared or archive lib):
      my @possible_libs = glob($full_libname_glob);
      # 
      map
         {
         $_ =~ s/\.so*|\.a*//g; # Remove all endings
         # Store in our hash of found libs:
         $libsfound->{$_} = 1;
         } @possible_libs;
      }
   
   # See if we find the library in the system lib directories:
   if (! exists ($libsfound->{'lib'.$library}))
      {
      $found = 1;
      }
   
   return $found;
   }

sub AUTOLOAD()
   {
   my ($xmlparser,$name,%attributes)=@_;
   return if $AUTOLOAD =~ /::DESTROY$/;
   my $name=$AUTOLOAD;
   $name =~ s/.*://;
   }

1;
Revision:	1.8
Committed:	Fri Dec 14 09:03:47 2007 UTC (17 years, 4 months ago) by muzaffar
Content type:	text/plain
Branch:	MAIN
CVS Tags:	V1_1_7, V1_1_6, V1_1_5, V1_1_4, V1_1_3, V1_1_2, V1_1_0_reltag8, V1_1_0_reltag7, V1_1_0_reltag6, V1_1_1, V1_1_0_reltag5, V1_1_0_reltag4, V1_1_0_reltag3, V1_1_0_reltag2, V1_1_0_reltag1, V1_1_0_reltag, V1_1_0_cand3, V1_1_0_cand2, V1_1_0_cand1
Branch point for:	forBinLess_SCRAM
Changes since 1.7:	+15 -24 lines
Log Message:	replace head with xml branch