From 3a63a427e6ba5379b02614eb25259f44d69d3ceb Mon Sep 17 00:00:00 2001 From: RoosterDragon Date: Fri, 18 Sep 2015 19:45:57 +0100 Subject: [PATCH] Improved sync lint pass. Now also checks for classes with Sync members lacking the ISync interface. --- .../Lint/CheckSyncAnnotations.cs | 47 ++++++++++++++----- 1 file changed, 34 insertions(+), 13 deletions(-) diff --git a/OpenRA.Mods.Common/Lint/CheckSyncAnnotations.cs b/OpenRA.Mods.Common/Lint/CheckSyncAnnotations.cs index 9215590ec2..d2ebd50715 100644 --- a/OpenRA.Mods.Common/Lint/CheckSyncAnnotations.cs +++ b/OpenRA.Mods.Common/Lint/CheckSyncAnnotations.cs @@ -9,6 +9,7 @@ #endregion using System; +using System.Collections.Generic; using System.Linq; using System.Reflection; using OpenRA.Traits; @@ -19,23 +20,43 @@ namespace OpenRA.Mods.Common.Lint { public void Run(Action emitError, Action emitWarning) { - /* first, check all the types implementing ISync */ - foreach (var t in Game.ModData.ObjectCreator.GetTypesImplementing()) - if (!HasAnySyncFields(t)) - emitWarning("{0} has ISync but nothing marked with [Sync]".F(t.Name)); + var modTypes = Game.ModData.ObjectCreator.GetTypes(); + CheckTypesWithSyncableMembersImplementSyncInterface(modTypes, emitWarning); + CheckTypesImplementingSyncInterfaceHaveSyncableMembers(modTypes, emitWarning); } - bool HasAnySyncFields(Type t) + static readonly Type SyncInterface = typeof(ISync); + + static bool TypeImplementsSync(Type type) { - var flags = BindingFlags.Public | BindingFlags.NonPublic - | BindingFlags.Instance; + return type.GetInterfaces().Contains(SyncInterface); + } - var fs = t.GetFields(flags); - var ps = t.GetProperties(flags); + static bool AnyTypeMemberIsSynced(Type type) + { + const BindingFlags Flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly; + while (type != null) + { + if (((MemberInfo[])type.GetFields(Flags)).Concat(type.GetProperties(Flags)).Any(x => x.HasAttribute())) + return true; + type = type.BaseType; + } - return fs.Any(f => f.HasAttribute()) || - ps.Any(p => p.HasAttribute()) || - HasAnySyncFields(t.BaseType); + return false; + } + + static void CheckTypesWithSyncableMembersImplementSyncInterface(IEnumerable types, Action emitWarning) + { + foreach (var type in types) + if (!TypeImplementsSync(type) && AnyTypeMemberIsSynced(type)) + emitWarning("{0} has members with the Sync attribute but does not implement ISync".F(type.FullName)); + } + + static void CheckTypesImplementingSyncInterfaceHaveSyncableMembers(IEnumerable types, Action emitWarning) + { + foreach (var type in types) + if (TypeImplementsSync(type) && !AnyTypeMemberIsSynced(type)) + emitWarning("{0} implements ISync but does not use the Sync attribute on any members.".F(type.FullName)); } } -} +} \ No newline at end of file