WebSVN – DevTools – Diff – /core_devl/trunk/TOOLS/LIB/ReadBuildConfig.pm

 ########################################################################
-# Copyright (c) VIX TECHNOLOGY (AUST) LTD
+# COPYRIGHT - VIX IP PTY LTD ("VIX"). ALL RIGHTS RESERVED.
+#
 # Module name   : jats.sh
 # Module type   : Makefile system
 # Compiler(s)   : n/a
 # Environment(s): jats build system
 @EXPORT      = qw(  ReadBuildConfig
                     getPlatformParts
                     getPackagePaths
                     getPackageList
                     getToolInfo
+                    testToolInfo
                     getAliases
                 );
 @EXPORT_OK =  qw(   $InterfaceVersion
                     $ScmBuildMachType
                     $ScmInterfaceVersion
                     $ScmDeploymentPatch
                     $ScmBuildSrc
                     $ScmExpert
                     $ScmAll
                     $ScmNoBuild
+                    $ScmBuildUuid
                     %ScmBuildAliases
                     %ScmBuildProducts
                     %ScmBuildPlatforms
                     %ScmBuildPkgRules
                     @BUILDPLATFORMS
+    }
     return ( @result );
+}
 #-------------------------------------------------------------------------------
-# Function        : getToolInfo
+# Function        : testToolInfo
+#
-# Description     : Locate and load the tool information for the named tool
+# Description     : Test to see if suitable toolInfo exists
+#                   May be used if the need for the toolInfo is optional
+#
-# Inputs          : $toolname           - tool to locate
+# Inputs          : $toolname       - Tool to locate
-#                   ...                 - Optional,Names of fields to expect in the package
-#                                         If any of the required fields ar missing an error
-#                                         will be reported
+#                   $error          - True: Error on not found
+#
-# Returns         : A hash of Tool info
+# Returns         : undefined       - No tool located
+#                   refToToolEntry  - Used internally
+#
-sub getToolInfo
+sub testToolInfo
+{
-    my ($toolname, @fnames) = @_;
+    my ($toolname, $error) = @_;
     my $toolroot;
     my $toolinfo;
     my $pentry;
-    my %data;
     my @searchPath;
     foreach my $entry ( getPackageList() )
+    {
         my $path = $entry->getBase(2);
             $toolroot = $path;
             $pentry = $entry;
             last;
+        }
+    }
-    if (defined $toolroot)
+    unless (defined $toolroot)
+    {
+        #   Didn't find the required tool
+        Error ("Cannot find required tool in any package: $toolname", "Search Path:", @searchPath) if ($error );
+        return undef ;
+    }
+    #
+    #   Return user info
+    #
+    return ($pentry, $toolroot, $toolinfo) if (wantarray);
+    return $pentry;
+}
+#-------------------------------------------------------------------------------
+# Function        : getToolInfo
+#
+# Description     : Locate and load the tool information for the named tool
+#
+# Inputs          : $toolname           - tool to locate
+#                   ...                 - Optional,Names of fields to expect in the package
+#                                         If any of the required fields ar missing an error
+#                                         will be reported
+#
+# Returns         : A hash of Tool info
+#
+sub getToolInfo
+{
+    my ($toolname, @fnames) = @_;
+    my %data;
+    #
+    #   Check existence and get essential information
+    #       Will not return if not found
+    #
+    my ($pentry, $toolroot, $toolinfo) = testToolInfo ($toolname, 1);
-        open (my $DATA, '<', $toolinfo ) || Error("Cannot open tool info file. $!", "File: $toolinfo");
+    open (my $DATA, '<', $toolinfo ) || Error("Cannot open tool info file. $!", "File: $toolinfo");
-        while ( <$DATA> )
+    while ( <$DATA> )
-        {
+    {
-            $_ =~ s~\s+$~~;
+        $_ =~ s~\s+$~~;
-            next if ( m~^#~ );
+        next if ( m~^#~ );
-            next if length($_) < 1;
+        next if length($_) < 1;
-            m~(.*?)\s*=\s*(.*)~;
+        m~(.*?)\s*=\s*(.*)~;
-            $data{$1} = $2;
+        $data{$1} = $2;
-        }
+    }
-        close $DATA;
+    close $DATA;
-        $data{PKGBASE} = $toolroot;
+    $data{PKGBASE} = $toolroot;
-        $data{PKGENTRY} = $pentry;
+    $data{PKGENTRY} = $pentry;
 #DebugDumpData("Data", \%data);
-        #
+    #
-        #   Ensure that the required fields are in the info file
+    #   Ensure that the required fields are in the info file
-        #   These will be a mix of mandatory and user fields
+    #   These will be a mix of mandatory and user fields
-        #
+    #
-        my @missing;
+    my @missing;
-        for my $fname ('TOOLNAME','TOOLROOT', @fnames)
+    for my $fname ('TOOLNAME','TOOLROOT', @fnames)
-        {
+    {
-            next if defined $data{$fname};
+        next if defined $data{$fname};
-            push @missing, $fname;
+        push @missing, $fname;
-        }
-        if (@missing)
-        {
-            Error("Tool Package '$toolname' is missing required fields:", @missing);
-        }
-        return \%data;
+    }
-    #   Didn't find the required tool
+    if (@missing)
+    {
-    Error ("Cannot find required tool in any package: $toolname", "Search Path:", @searchPath);
+        Error("Tool Package '$toolname' is missing required fields:", @missing);
+    }
+    return \%data;
+}
 ################################################################################
 #   PackageEntry
 # Returns         : As above
+#
 sub getBase
+{
     my ($self, $type ) = @_;
+    ::Error ("Internal: PackageEntry::getBase called without 'type' argument") unless defined $type;
     if ( $type == 1 ) {
         return $self->{ROOT};
     } elsif ( $type == 2 ) {
         if ( $self->{'TYPE'} eq 'build' ) {

Subversion Repositories DevTools

(root)/core_devl/trunk/TOOLS/LIB/ReadBuildConfig.pm – Rev 6133 → 6177