UpdatePath.cs

#region Copyright & License Information
/*
 * Copyright 2007-2019 The OpenRA Developers (see AUTHORS)
 * This file is part of OpenRA, which is free software. It is made
 * available to you under the terms of the GNU General Public License
 * as published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version. For more
 * information, see COPYING.
 */
#endregion

using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using OpenRA.Mods.Common.UpdateRules.Rules;

namespace OpenRA.Mods.Common.UpdateRules
{
	public class UpdatePath
	{
		// Define known update paths from stable tags to the current bleed tip
		//
		// This file should be maintained separately on prep branches vs bleed.
		// The bleed version of this file should ignore the presence of the prep branch
		// and list rules from the playtest that forked the prep branch and current bleed.
		// The prep branch should maintain its own list of rules along the prep branch
		// until the eventual final release.
		//
		// When a final release has been tagged the update paths from the prep branch
		// can be merged back into bleed by replacing the forking-playtest-to-bleed path
		// with the prep playtest-to-playtest-to-release paths and finally a new/modified
		// release-to-bleed path.
		[SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1118:ParameterMustNotSpanMultipleLines",
			Justification = "Extracting update lists to temporary variables obfuscates the definitions.")]
		static readonly UpdatePath[] Paths =
		{
			new UpdatePath("release-20171014", "release-20180218", new UpdateRule[]
			{
				new LegacyBetaWarning(),
				new RemoveMobileOnRails(),
				new AircraftCanHoverGeneralization(),
				new AddNukeLaunchAnimation(),
				new RenameWithTurreted(),
				new RemovePlayerPaletteTileset(),
				new CapturableChanges(),
				new DecoupleSelfReloading(),
				new RemoveOutOfAmmo(),
				new ChangeCanPowerDown(),
				new ReplaceRequiresPower(),
				new DropPauseAnimationWhenDisabled(),
				new ChangeBuildableArea(),
				new MoveVisualBounds(),
				new ScaleDefaultModHealth(),
				new ReworkCheckboxes(),
				new SplitGateFromBuilding(),
				new RemoveIDisable(),
				new ReplaceCanPowerDown(),
				new ScaleSupportPowerSecondsToTicks(),
				new WarnAboutInfiltrateForTypes(),
				new RenameBurstDelay(),
			}),

			new UpdatePath("release-20180218", "release-20180307", new UpdateRule[0]),

			new UpdatePath("release-20180307", "release-20180923", new UpdateRule[]
			{
				new RemoveTerrainTypeIsWaterFlag(),
				new DefineSquadExcludeHarvester(),
				new RemoveWeaponScanRadius(),
				new SplitAimAnimations(),
				new DefineSoundDefaults(),
				new RenameWormSpawner(),
				new RemoveWithReloadingSpriteTurret(),
				new ChangeIntensityToDuration(),
				new IgnoreAbstractActors(),
				new AddShakeToBridge(),
				new RemovePaletteFromCurrentTileset(),
				new DefineLocomotors(),
				new DefineOwnerLostAction(),
				new RenameEmitInfantryOnSell(),
				new SplitRepairDecoration(),
				new MoveHackyAISupportPowerDecisions(),
				new DefineGroundCorpseDefault(),
				new RemoveCanUndeployFromGrantConditionOnDeploy(),
			}),

			new UpdatePath("release-20180923", "release-20181215", new UpdateRule[0]),

			new UpdatePath("release-20181215", "release-20190314", new UpdateRule[]
			{
				new AddCarryableHarvester(),
				new RenameEditorTilesetFilter(),
				new DefineNotificationDefaults(),
				new MergeRearmAndRepairAnimation(),
				new MergeCaptureTraits(),
				new RemovedNotifyBuildComplete(),
				new LowPowerSlowdownToModifier(),
				new ChangeTakeOffSoundAndLandingSound(),
				new RemoveHealthPercentageRing(),
				new RenameCrateActionNotification(),
				new RemoveRepairBuildingsFromAircraft(),
				new AddRearmable(),
				new MergeAttackPlaneAndHeli(),
				new RemovedDemolishLocking(),
				new RequireProductionType(),
				new CloakRequiresConditionToPause(),
				new ExtractHackyAIModules(),
				new RemoveNegativeDamageFullHealthCheck(),
				new RemoveResourceExplodeModifier(),
				new DefineLevelUpImageDefault(),
				new RemovedAutoCarryallCircleTurnSpeed(),
				new RemoveAttackIgnoresVisibility(),
				new ReplacedWithChargeAnimation(),
				new RefactorResourceLevelAnimating(),
				new RemoveAttackSuicides(),
			}),

			new UpdatePath("release-20190314", "release-20191117", new UpdateRule[]
			{
				new MultipleDeploySounds(),
				new RemoveSimpleBeacon(),
				new MakeMobilePausableConditional(),
				new StreamlineRepairableTraits(),
				new ReplaceSpecialMoveConsiderations(),
				new RefactorHarvesterIdle(),
				new SplitHarvesterSpriteBody(),
				new RenameAttackMoveConditions(),
				new RemovePlaceBuildingPalettes(),
				new RenameHoversOffsetModifier(),
				new AddAirAttackTypes(),
				new MoveAbortOnResupply(),
				new RenameCarryallDelays(),
				new AddCanSlide(),
				new AddAircraftIdleBehavior(),
				new RenameSearchRadius(),
				new RenameChronoshiftFootprint(),
				new RemoveMoveIntoWorldFromExit(),
			}),

			new UpdatePath("release-20191117", new UpdateRule[]
			{
				// Bleed only changes here
				new RemoveYesNo(),
				new RemoveInitialFacingHardcoding(),
				new RemoveAirdropActorTypeDefault(),
			})
		};

		public static IEnumerable<UpdateRule> FromSource(ObjectCreator objectCreator, string source, bool chain = true)
		{
			// Use reflection to identify types
			var namedType = objectCreator.FindType(source);
			if (namedType != null && namedType.IsSubclassOf(typeof(UpdateRule)))
				return new[] { (UpdateRule)objectCreator.CreateBasic(namedType) };

			var namedPath = Paths.FirstOrDefault(p => p.source == source);
			return namedPath != null ? namedPath.Rules(chain) : null;
		}

		public static IEnumerable<string> KnownPaths { get { return Paths.Select(p => p.source); } }
		public static IEnumerable<string> KnownRules(ObjectCreator objectCreator)
		{
			return objectCreator.GetTypesImplementing<UpdateRule>().Select(t => t.Name);
		}

		readonly string source;
		readonly string chainToSource;
		readonly UpdateRule[] rules;
		UpdatePath(string source, UpdateRule[] rules)
			: this(source, null, rules) { }

		UpdatePath(string source, string chainToSource, UpdateRule[] rules)
		{
			this.source = source;
			this.rules = rules;
			this.chainToSource = chainToSource;
		}

		IEnumerable<UpdateRule> Rules(bool chain = true)
		{
			if (chainToSource != null && chain)
			{
				var child = Paths.First(p => p.source == chainToSource);
				return rules.Concat(child.Rules(chain));
			}

			return rules;
		}
	}
}