epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improved sync lint pass.

Browse Source 
Now also checks for classes with Sync members lacking the ISync interface.
This commit is contained in:
RoosterDragon
2015-09-18 19:45:57 +01:00
parent 6b62aa1ad5
commit 3a63a427e6
1 changed files with 34 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
OpenRA.Mods.Common/Lint/CheckSyncAnnotations.cs
View File

@@ -9,6 +9,7 @@
#endregion #endregion
using System; using System;
using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Reflection; using System.Reflection;
using OpenRA.Traits; using OpenRA.Traits;
@@ -19,23 +20,43 @@ namespace OpenRA.Mods.Common.Lint
{ {
public void Run(Action<string> emitError, Action<string> emitWarning) public void Run(Action<string> emitError, Action<string> emitWarning)
{ {
/* first, check all the types implementing ISync */ var modTypes = Game.ModData.ObjectCreator.GetTypes();
foreach (var t in Game.ModData.ObjectCreator.GetTypesImplementing<ISync>()) CheckTypesWithSyncableMembersImplementSyncInterface(modTypes, emitWarning);
if (!HasAnySyncFields(t)) CheckTypesImplementingSyncInterfaceHaveSyncableMembers(modTypes, emitWarning);
emitWarning("{0} has ISync but nothing marked with [Sync]".F(t.Name));
} }
bool HasAnySyncFields(Type t) static readonly Type SyncInterface = typeof(ISync);
static bool TypeImplementsSync(Type type)
{ {
var flags = BindingFlags.Public | BindingFlags.NonPublic return type.GetInterfaces().Contains(SyncInterface);
| BindingFlags.Instance; }
var fs = t.GetFields(flags); static bool AnyTypeMemberIsSynced(Type type)
var ps = t.GetProperties(flags); {
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<SyncAttribute>()))
return true;
type = type.BaseType;
}
return fs.Any(f => f.HasAttribute<SyncAttribute>()) || return false;
ps.Any(p => p.HasAttribute<SyncAttribute>()) || }
HasAnySyncFields(t.BaseType);
static void CheckTypesWithSyncableMembersImplementSyncInterface(IEnumerable<Type> types, Action<string> 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<Type> types, Action<string> 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));
} }
} }
} }