modules/WixWorkspaceCreator.pm

   1 package WixWorkspaceCreator;
   2
   3 # ************************************************************
   4 # Description   : A Wix Workspace creator
   5 # Author        : James H. Hill
   6 # Create Date   : 6/23/2009
   7 # ************************************************************
   8
   9 # ************************************************************
  10 # Pragmas
  11 # ************************************************************
  12
  13 use strict;
  14 use WixProjectCreator;
  15 use WorkspaceCreator;
  16 use WinWorkspaceBase;
  17 use File::Basename;
  18
  19 use vars qw(@ISA);
  20 @ISA = qw(WinWorkspaceBase WorkspaceCreator);
  21
  22 # ************************************************************
  23 # Data Section
  24 # ************************************************************
  25
  26
  27 # ************************************************************
  28 # Subroutine Section
  29 # ************************************************************
  30
  31 sub workspace_file_extension {
  32   return '.wxs';
  33 }
  34
  35 sub workspace_file_name {
  36   my $self = shift;
  37   return $self->get_modified_workspace_name($self->get_workspace_name(),
  38                                             '.wxi');
  39 }
  40
  41 sub pre_workspace {
  42   my($self, $fh) = @_;
  43   my $crlf = $self->crlf();
  44   my $name = $self->get_workspace_name();
  45
  46   ## Begin the project definition for the workspace
  47   print $fh '<?xml version="1.0" encoding="utf-8" standalone="yes"?>', $crlf,
  48             '<Include>', $crlf;
  49 }
  50
  51 sub write_comps {
  52   my($self, $fh) = @_;
  53   my $crlf = $self->crlf();
  54
  55
  56   # print the target for clean
  57   foreach my $project ($self->sort_dependencies($self->get_projects(), 0)) {
  58     print $fh "  <?include $project ?>", $crlf;
  59   }
  60 }
  61
  62
  63 sub normalize {
  64   my $val = shift;
  65   $val =~ tr/ \t\/\\\-$()./_/;
  66   return $val;
  67 }
  68
  69 sub post_workspace {
  70   my($self, $fh, $gen) = @_;
  71   my $info = $self->get_project_info();
  72   my $crlf = $self->crlf();
  73
  74   # Create a component group consisting of all the projects.
  75   print $fh $crlf,
  76             '  <Fragment>', $crlf,
  77             '    <ComponentGroup Id="',
  78             $self->get_workspace_name(), '">', $crlf;
  79
  80   foreach my $project ($self->sort_dependencies($self->get_projects(), 0)) {
  81     print $fh '      <ComponentGroupRef Id="ComponentGroup.',
  82               $$info{$project}->[ProjectCreator::PROJECT_NAME], '" />',
  83               $crlf;
  84   }
  85
  86   print $fh '    </ComponentGroup>', $crlf,
  87             '  </Fragment>', $crlf;
  88
  89
  90
  91   print $fh $crlf;
  92
  93   # For every project marked with "make_group", create a ComponentGroup that references all dependencies
  94   my %project_dependencies = ();
  95   my $projects = $self->get_projects();
  96   my @list = $self->sort_dependencies($projects, 0);
  97   foreach my $project (@list) {
  98     my $deps = $self->get_validated_ordering($project);
  99     $project_dependencies{$project} = [ @$deps ];
 100   }
 101
 102   # for each project, find all dependencies
 103   foreach my $project (keys %project_dependencies) {
 104     # foreach my $cfg (@cfgs_main) -> <configuration|platform> could be <Debug|AnyCPU Release|AnyCPU> or <Debug|Win32 Release|Win32 Debug|x64 Release|x64>
 105     my($pname_main, $make_group_main, @cfgs_main) =
 106       $gen->access_pi_values($info, $project,
 107                              ProjectCreator::PROJECT_NAME,
 108                              ProjectCreator::MAKE_GROUP,
 109                              ProjectCreator::CONFIGURATIONS);
 110     # only generate a group if "make_group = 1"
 111     if ($make_group_main) {
 112       # all dependencies used by any project referenced by $project
 113       my %all_deps;
 114       my @dep_stack = ($project);
 115       while (my $top = pop @dep_stack) {
 116         # add current project to dependencies (use hash key as set)
 117         $all_deps{$top} = 1;
 118         my $deps = $project_dependencies{$top};
 119         foreach my $dep (@$deps) {
 120           # add current project's dependencies to stack for processing, if not already processed
 121           push(@dep_stack, $dep) if !exists $all_deps{$dep};
 122         }
 123       }
 124
 125       # for every config/platform pairing, emit a MainGroup
 126       foreach my $cfg (@cfgs_main) {
 127         my ($config, $platform) = split('\|', $cfg);
 128
 129         print $fh '  <Fragment>', $crlf,
 130                   '    <ComponentGroup Id="MainGroup.', normalize($config),
 131                   '_', normalize($platform), '_', $pname_main, '">', $crlf;
 132
 133         # add main project - pattern is "ComponentGroup.<Debug|Release>_<Win32|x64|AnyCPU>_<projectname>"
 134         print $fh '      <ComponentGroupRef Id="ComponentGroup.',
 135                   normalize($config), '_', normalize($platform), '_',
 136                   $pname_main, '" />', $crlf;
 137
 138         # loop over each dependency, and obtain its parameters
 139         foreach my $dep (keys %all_deps) {
 140           foreach my $p (@{$self->{'projects'}}) {
 141             if ($dep eq $info->{$p}->[ProjectCreator::PROJECT_NAME] ||
 142                 $dep eq $self->mpc_basename($p)) {
 143               my($pname_dep, @cfgs_dep) =
 144                 $gen->access_pi_values($info, $p,
 145                                        ProjectCreator::PROJECT_NAME,
 146                                        ProjectCreator::CONFIGURATIONS);
 147
 148               # add dependency - include AnyCPU if no dependency configuration matches exactly (if the AnyCPU platform exists, that is)
 149               my $pform = $platform;
 150               if (!exists {map { $_ => 1 } @cfgs_dep}->{$config.'|'.$pform}) {
 151                 $pform = 'AnyCPU';
 152               }
 153               if (exists {map { $_ => 1 } @cfgs_dep}->{$config.'|'.$pform}) {
 154                 print $fh '      <ComponentGroupRef Id="ComponentGroup.',
 155                           normalize($config), '_', normalize($pform),
 156                           '_', $pname_dep, '" />', $crlf;
 157               }
 158               last;
 159             }
 160           }
 161         }
 162
 163         print $fh '    </ComponentGroup>', $crlf,
 164                   '  </Fragment>', $crlf, $crlf;
 165       }
 166     }
 167   }
 168
 169   print $fh '</Include>', $crlf;
 170 }
 171
 172 1;