/// <summary>
/// Performs a resynchronisation, synchronisation, generation or clean on the specified module.
/// </summary>
/// <returns><c>true</c>, if the action succeeded, <c>false</c> otherwise.</returns>
/// <param name="module">The module to perform the action on.</param>
/// <param name="action">The action to perform, either "resync", "sync", "generate" or "clean".</param>
/// <param name="platform">The platform to perform the action for.</param>
/// <param name="enabledServices">A list of enabled services.</param>
/// <param name="disabledServices">A list of disabled services.</param>
/// <param name="serviceSpecPath">The service specification path.</param>
public bool PerformAction(
ModuleInfo module,
string action,
string platform = null,
string[] enabledServices = null,
string[] disabledServices = null,
string serviceSpecPath = null)
{
var platformSupplied = !string.IsNullOrWhiteSpace(platform);
if (string.IsNullOrWhiteSpace(platform))
{
platform = this.m_HostPlatformDetector.DetectPlatform();
}
var originalPlatform = platform;
platform = module.NormalizePlatform(platform);
if (platform == null && !platformSupplied)
{
// The current host platform isn't supported, so we shouldn't try to
// operate on it.
string firstPlatform = null;
switch (this.m_HostPlatformDetector.DetectPlatform())
{
case "Windows":
firstPlatform = module.DefaultWindowsPlatforms.Split(',').FirstOrDefault();
break;
case "MacOS":
firstPlatform = module.DefaultMacOSPlatforms.Split(',').FirstOrDefault();
break;
case "Linux":
firstPlatform = module.DefaultLinuxPlatforms.Split(',').FirstOrDefault();
break;
}
if (firstPlatform != null)
{
// This will end up null if the first platform isn't supported
// either and hence throw the right message.
platform = module.NormalizePlatform(firstPlatform);
}
}
if (platform == null)
{
Console.Error.WriteLine("The platform '" + originalPlatform + "' is not supported.");
Console.Error.WriteLine("The following platforms are supported by this module:");
foreach (
var supportedPlatform in
module.SupportedPlatforms.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries)
.Select(x => x.Trim())
.Where(x => !string.IsNullOrWhiteSpace(x)))
{
Console.Error.WriteLine(" * " + supportedPlatform);
}
ExecEnvironment.Exit(1);
return(false);
}
var primaryPlatform = platform;
// You can generate multiple targets by default by setting the <DefaultWindowsPlatforms>
// <DefaultMacOSPlatforms> and <DefaultLinuxPlatforms> tags in Module.xml. Note that
// synchronisation will only be done for the primary platform, as there is no correct
// synchronisation behaviour when dealing with multiple C# projects.
//
// We only trigger this behaviour when the platform is omitted; if you explicitly
// specify "Windows" on the command line, we'll only generate / resync / sync
// the Windows platform.
string multiplePlatforms = null;
if (!platformSupplied)
{
switch (platform)
{
case "Windows":
multiplePlatforms = module.DefaultWindowsPlatforms;
break;
case "MacOS":
multiplePlatforms = module.DefaultMacOSPlatforms;
break;
case "Linux":
multiplePlatforms = module.DefaultLinuxPlatforms;
break;
}
}
// If no overrides are set, just use the current platform.
if (string.IsNullOrEmpty(multiplePlatforms))
{
multiplePlatforms = platform;
}
// Resolve submodules as needed.
this.m_PackageManager.ResolveAll(module, primaryPlatform);
// You can configure the default action for Protobuild in their project
// with the <DefaultAction> tag in Module.xml. If omitted, default to a resync.
// Valid options for this tag are either "Generate", "Resync" or "Sync".
// If the actions are "Resync" or "Sync", then we need to perform an initial
// step against the primary platform.
switch (action.ToLower())
{
case "generate":
if (!this.GenerateProjectsForPlatform(module, primaryPlatform, enabledServices, disabledServices, serviceSpecPath))
{
return(false);
}
break;
case "resync":
if (!this.ResyncProjectsForPlatform(module, primaryPlatform, enabledServices, disabledServices, serviceSpecPath))
{
return(false);
}
break;
case "sync":
return(this.SyncProjectsForPlatform(module, primaryPlatform));
case "clean":
if (!this.CleanProjectsForPlatform(module, primaryPlatform))
{
return(false);
}
break;
default:
Console.Error.WriteLine("Unknown option in <DefaultAction> tag of Module.xml. Defaulting to resync!");
return(this.ResyncProjectsForPlatform(module, primaryPlatform, enabledServices, disabledServices, serviceSpecPath));
}
// Now iterate through the multiple platforms specified.
var multiplePlatformsArray =
multiplePlatforms.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(x => x.Trim());
foreach (var platformIter in multiplePlatformsArray)
{
if (platformIter == primaryPlatform)
{
// Already handled above.
continue;
}
// Resolve submodules as needed.
this.m_PackageManager.ResolveAll(module, platformIter);
switch (action.ToLower())
{
case "generate":
case "resync":
// We do a generate under resync mode since we only want the primary platform
// to have synchronisation done (and it has had above).
if (!this.GenerateProjectsForPlatform(module, platformIter, enabledServices, disabledServices, serviceSpecPath))
{
return(false);
}
break;
case "clean":
if (!this.CleanProjectsForPlatform(module, platformIter))
{
return(false);
}
break;
default:
throw new InvalidOperationException("Code should never reach this point");
}
}
// All the steps succeeded, so return true.
return(true);
}
public static bool PerformAction(ModuleInfo module, string action, string platform = null)
{
var platformSupplied = !string.IsNullOrWhiteSpace(platform);
if (string.IsNullOrWhiteSpace(platform))
{
platform = DetectPlatform();
}
var originalPlatform = platform;
platform = module.NormalizePlatform(platform);
if (platform == null)
{
Console.Error.WriteLine("The platform '" + originalPlatform + "' is not supported.");
Console.Error.WriteLine("The following platforms are supported by this module:");
foreach (
var supportedPlatform in
module.SupportedPlatforms.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries)
.Select(x => x.Trim())
.Where(x => !string.IsNullOrWhiteSpace(x)))
{
Console.Error.WriteLine(" * " + supportedPlatform);
}
Environment.Exit(1);
return false;
}
var primaryPlatform = platform;
// You can generate multiple targets by default by setting the <DefaultWindowsPlatforms>
// <DefaultMacOSPlatforms> and <DefaultLinuxPlatforms> tags in Module.xml. Note that
// synchronisation will only be done for the primary platform, as there is no correct
// synchronisation behaviour when dealing with multiple C# projects.
//
// We only trigger this behaviour when the platform is omitted; if you explicitly
// specify "Windows" on the command line, we'll only generate / resync / sync
// the Windows platform.
string multiplePlatforms = null;
if (!platformSupplied)
{
switch (platform)
{
case "Windows":
multiplePlatforms = module.DefaultWindowsPlatforms;
break;
case "MacOS":
multiplePlatforms = module.DefaultMacOSPlatforms;
break;
case "Linux":
multiplePlatforms = module.DefaultLinuxPlatforms;
break;
}
}
// If no overrides are set, just use the current platform.
if (string.IsNullOrEmpty(multiplePlatforms))
{
multiplePlatforms = platform;
}
// You can configure the default action for Protobuild in their project
// with the <DefaultAction> tag in Module.xml. If omitted, default to a resync.
// Valid options for this tag are either "Generate", "Resync" or "Sync".
// If the actions are "Resync" or "Sync", then we need to perform an initial
// step against the primary platform.
switch (action.ToLower())
{
case "generate":
if (!Actions.GenerateProjectsForPlatform(module, primaryPlatform))
{
return false;
}
break;
case "resync":
if (!Actions.ResyncProjectsForPlatform(module, primaryPlatform))
{
return false;
}
break;
case "sync":
return Actions.SyncProjectsForPlatform(module, primaryPlatform);
case "clean":
if (!Actions.CleanProjectsForPlatform(module, primaryPlatform))
{
return false;
}
break;
default:
Console.Error.WriteLine("Unknown option in <DefaultAction> tag of Module.xml. Defaulting to resync!");
return Actions.ResyncProjectsForPlatform(module, primaryPlatform);
}
// Now iterate through the multiple platforms specified.
var multiplePlatformsArray =
multiplePlatforms.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(x => x.Trim());
foreach (var platformIter in multiplePlatformsArray)
{
if (platformIter == primaryPlatform)
{
// Already handled above.
continue;
}
switch (action.ToLower())
{
case "generate":
case "resync":
// We do a generate under resync mode since we only want the primary platform
// to have synchronisation done (and it has had above).
if (!Actions.GenerateProjectsForPlatform(module, platformIter))
{
return false;
}
break;
case "clean":
if (!Actions.CleanProjectsForPlatform(module, platformIter))
{
return false;
}
break;
default:
throw new InvalidOperationException("Code should never reach this point");
}
}
// All the steps succeeded, so return true.
return true;
}
