#region Copyright & License Information /* * Copyright 2007-2022 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; using System.Collections.Generic; using System.Linq; using System.Reflection; namespace OpenRA.Mods.Common.Lint { class CheckSyncAnnotations : ILintPass { public void Run(Action emitError, Action emitWarning, ModData modData) { var modTypes = modData.ObjectCreator.GetTypes(); CheckTypesWithSyncableMembersImplementSyncInterface(modTypes, emitWarning); CheckTypesImplementingSyncInterfaceHaveSyncableMembers(modTypes, emitWarning); } static readonly Type SyncInterface = typeof(ISync); static bool TypeImplementsSync(Type type) { return type.GetInterfaces().Contains(SyncInterface); } 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 false; } static void CheckTypesWithSyncableMembersImplementSyncInterface(IEnumerable types, Action emitWarning) { foreach (var type in types) if (!TypeImplementsSync(type) && AnyTypeMemberIsSynced(type)) emitWarning($"{type.FullName} has members with the Sync attribute but does not implement ISync"); } static void CheckTypesImplementingSyncInterfaceHaveSyncableMembers(IEnumerable types, Action emitWarning) { foreach (var type in types) if (TypeImplementsSync(type) && !AnyTypeMemberIsSynced(type)) emitWarning($"{type.FullName} implements ISync but does not use the Sync attribute on any members."); } } }