WebSVN – DevTools – Diff – /manifest-tool/trunk/src/gbe/DIRECTIVES/ManifestFiles.pm

 #                       --LineLength=nnn        - Limit line length. Default is 79
 #                       --SubManifest           - Create a sub-manifest (not installable). Manifest will have no version.
 #                                                 Gives a default name, tier and subdir if not explicitly provided.
 #                       --NoSignatures          - Prevent the generation of .sig files
 #                                                 Default is to generate .sigFiles
+#                       --ManifestInsertionPoint[,--All,--Name,--Name=xxxx,--Tier,--Tier=Name,--Current]
+#                                                 Create template insertion hook
+#                       --Template=Package[,--Subdir=subdir,File=name]
 #                       --NoWarn                - Supress warnings about unused packages
 #                                                 Will supress sanity test. Useful when generating multiple
 #                                                 manifests.
+#
 # Notes: On sig file generation
+            #
             $tier = $import_info->{'tier'} unless ( defined $tier );
             $name = $import_info->{'name'} unless ( defined $name );
             $imported_manifest = 1;
+        } elsif ( m/^--ManifestInsertionPoint(.*)/i ) {
+            my $insert_info = ManifestFiles::_InsertPoint($1, $tier, $name);
+#DebugDumpData("InsertPoint", $insert_info );
+            push @files, {'insertPoint' => $insert_info };
+        } elsif ( m/^--Template=(.+)/i ) {
+            my $template_info = ManifestFiles::_Template($1, $tier, $name);
+#DebugDumpData("TemplateInfo", $template_info );
+            push @files, {'template' => $template_info };
         } elsif (m/^--Md5/i) {
             $include_md5 = 1;
             $useDefaultLineWidth = 0;
         } elsif (m/^--Dmf/i) {
 our %package_dirs;                  # Package dirs discovered and used
 our $ManifestFiles;                 # Files in the Manifest
 our $noWarn = 0;                    # Control unused package warnings
 our $pkgBase;                       # Where the package is being sourced from
 our $noSigs = 1;                    # Control signature generation (Force noSigs. could use use undef)
+our $templateMode;                  # In templating mode
+#
 #   Internal
 #   Used while generating a manifest
+#
+    {
         $package_name = $1;
         @dirs = split( ',', $2 );
+    }
-    my $package = GetPackageEntry( $package_name );
+    my $package = ::GetPackageEntry( $package_name );
     unless ( $package )
+    {
         ReportError ("ManifestFiles: Package not known to build: $package_name");
         return undef;
+    }
                 ReportError("ManifestFiles: Unknown suboption to ImportManifest:" . $_);
+            }
+        }
+    }
-    my $package = GetPackageEntry( $package_name );
+    my $package = ::GetPackageEntry( $package_name );
     unless ( $package )
+    {
         ReportError ("ManifestFiles: Package not known to build: $package_name");
         return undef;
+    }
               'rewrite' => $rewrite,
             };
+}
 #-------------------------------------------------------------------------------
+# Function        : _InsertPoint
+#
+# Description     : Create a Manifest Insertion Point
+#
+# Inputs          : Args    - [,--All,--Name,--Name=xxxx,--Tier,--Tier=Name, --Current]
+#                   tier    - May be null
+#                   name    - May be null
+#
+# Returns         : A hash of data to be used later
+#
+sub _InsertPoint
+{
+    my ($args, $tier, $name) = @_;
+    my @item_list;
+    ReportError("ManifestFiles: ManifestInsertionPoint. Name not yet specified") unless defined $name;
+    ReportError("ManifestFiles: ManifestInsertionPoint. Tier not yet specified") unless defined $tier;
+    my $argName = $name;
+    my $argTier = $tier;
+    #
+    #   Extract sub options
+    #
+    my @subargs = split(',--', $args);
+    foreach ( @subargs)
+    {
+        next unless (length($_) > 0);
+        if (m~^All$~i){
+            $argName = '*';
+            $argTier = '*';
+        } elsif (m~^Name(=(.*))?~i){
+            if ( $1 ){
+                $argName = $2;
+            } else {
+                $argName = $name;
+            }
+        } elsif (m~^Tier(=(.*))?~i){
+            if ( $1 ){
+                $argTier = $2;
+            } else {
+                $argTier = $tier;
+            }
+        } elsif (m~^Current$~i){
+            $argName = $name;
+            $argTier = $tier;
+        } else {
+            ReportError("ManifestFiles: Unknown suboption to ManifestInsertionPoint:" . $_);
+        }
+    }
+    return { 'tier' => $argTier,
+             'name' => $argName,
+           };
+}
+#-------------------------------------------------------------------------------
+# Function        : _Template
+#
+# Description     : Capture templating information
+#
+# Inputs          : --Template=Package[,--Subdir=subdir,File=name]
+#                   tier    - May be null
+#                   name    - May be null
+#
+# Returns         : A hash of data to be used later
+#
+sub _Template
+{
+    my ($args, $tier, $name) = @_;
+    my $subdir = 'mug';
+    my $manifest;
+    #
+    #   Can only use the Template directive once
+    #
+    if ($templateMode) {
+        ReportError ("ManifestFiles:--Template option is only allowed once");
+        return undef;
+    }
+    $templateMode = 1;
+    #
+    #   Locate the mugfile subdir
+    #
+    my $package_name = $args;
+    #
+    #   Extract sub options
+    #       --Subdir=xxxx
+    #       --File=name
+    #
+    if ( $package_name =~ m/(.*?)(,.*)/ )
+    {
+        $package_name = $1;
+        my @subargs = split(',--', $2);
+        foreach ( @subargs)
+        {
+            next unless (length($_) > 0);
+            if (m~^Subdir=(.*)~i){
+                $subdir = $1;
+            } elsif (m~^File=(.*)~i) {
+                $manifest = $1;
+            } else {
+                ReportError("ManifestFiles: Unknown suboption to Template:" . $_);
+            }
+        }
+    }
+    my $package = ::GetPackageEntry( $package_name );
+    unless ( $package )
+    {
+        ReportError ("ManifestFiles: Package not known to build: $package_name");
+        return undef;
+    }
+    my $pkg_root = $package->{'ROOT'};
+    my $pkgDir = CatPaths( $pkg_root, $subdir);
+    unless (-d $pkgDir) {
+        ReportError ("ManifestFiles: Template subdir not found in $package_name: $subdir");
+        return undef;
+    }
+    #
+    #   Determine Manifest File name, unless specified by user
+    #
+    unless ($manifest) {
+        foreach my $file ( glob ($pkgDir . '/Manifest*' ) )
+        {
+                next unless ( -f $file );
+                if ( $manifest ) {
+                    Warning ("Multiple Manifest Files find. Only the first will be used",
+                             "Using: $manifest",
+                             "Ignoring: $file" ) ;
+                    next;
+                }
+                $manifest = $file;
+        }
+        unless ($manifest)
+        {
+            ReportError ("ImportManifest. No Manifest template found: $package_name");
+            return undef;
+        }
+    } else {
+        $manifest = CatPaths($pkgDir, $manifest);
+    }
+    unless (-f $manifest) {
+        ReportError ("ImportManifest. No Manifest template found: $package_name, $subdir, $manifest");
+        return undef;
+    }
+    #
+    #   Return paramters for later processing
+    #
+    $package_dirs{$pkg_root}{used} = 1;
+    return { 'manifest' => $manifest,
+             'pkg_dir' => $pkg_root,
+             'subdir' => $subdir,
+             'manifest_dir' => $pkgDir,
+             'package' => $package_name,
+    };
+}
+#-------------------------------------------------------------------------------
 # Function        : Generate
+#
 # Description     : Internal Function
 #                   Process all the collected data and create directives
 #                   for the creation of the manifest
+    #
     #   Process each tier in the order presented in the source file
+    #
     my $last_was_comment = 0;
+    my $last_was_insert = 0;
     foreach my $entry ( @Manifests )
+    {
 #DebugDumpData ( "Manifest Entry", $entry );
                 print_mf ( map (('# ' . $_) , split ("\n", $cmt) ));
                 $last_was_comment = 1;
                 next;
+            }
-            print_mf ('#') if ( $last_was_comment );
+            print_mf ('#') if ( $last_was_comment);
+            $last_was_comment = 0;
+            if ( my $ip = $fentry->{'insertPoint'} ) {
+               #
+               #   Create an insertion point
+               #   Looks like a comment for the purposes of backward compatability
+               #
+               print_mf ('') unless $last_was_insert;
+               print_mf ("##INSERT POINT [Name:$ip->{name}] [Tier:$ip->{tier}]");
+               $last_was_insert = 1;
+               next;
+            }
+            print_mf ('#') if ( $last_was_insert);
+            $last_was_insert = 0;
             if ( my $file = $fentry->{'file'} )
+            {
                 my $base_file = StripDir( $file );
                 my @items = ($name, $tier, $base_file);
                 if ($include_md5) {
                 if (exists $entry->{fileVersions} && exists $entry->{fileVersions}{$file} ) {
                     push @items, "VERSION=" . $entry->{fileVersions}{$file};
+                }
                 print_mf (join (',', @items));
                 PackageManifestFile ($name, $tier, $file );
-                $last_was_comment = 0;
+            }
             if ( my $file = $fentry->{'filenocopy'} )
+            {
                 print_mf ("$name,$tier,$file");
-                $last_was_comment = 0;
+            }
             if ( my $emf = $fentry->{'manifest'} )
+            {
-                $last_was_comment = 0;
+                #
                 #   Insert the entire manifest
                 #   Items are:
                 #        contents
                 #        items:
 #-------------------------------------------------------------------------------
 # Function        : PackageManifestFile
+#
 # Description     : Process and package a manifest file
-#                       Reatin a list of files in the mnifest to allow postprocessing
+#                       Retain a list of files in the manifest to allow postprocessing
 #                       such as signature generation
+#
+#
 # Inputs          : $name           - Target platform name
 #                   $tier           - Target tier

Subversion Repositories DevTools

(root)/manifest-tool/trunk/src/gbe/DIRECTIVES/ManifestFiles.pm – Rev 6962 → 6978