using System; using System.Collections; using System.Collections.Generic; using System.Collections.Immutable; using System.Linq; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.CSharp; using Microsoft.CodeAnalysis.Diagnostics; namespace StardewModdingAPI.ModBuildConfig.Analyzer { /// Detects implicit conversion from Stardew Valley's Netcode types. These have very unintuitive implicit conversion rules, so mod authors should always explicitly convert the type with appropriate null checks. [DiagnosticAnalyzer(LanguageNames.CSharp)] public class NetFieldAnalyzer : DiagnosticAnalyzer { /********* ** Properties *********/ /// The namespace for Stardew Valley's Netcode types. private const string NetcodeNamespace = "Netcode"; /// The full name for Stardew Valley's Netcode.NetList type. private readonly string NetListTypeFullName = "Netcode.NetList"; /// The full name for Stardew Valley's Netcode.NetCollection type. private readonly string NetCollectionTypeFullName = "Netcode.NetCollection"; /// Maps net fields to their equivalent non-net properties where available. private readonly IDictionary NetFieldWrapperProperties = new Dictionary { // Character ["StardewValley.Character::currentLocationRef"] = "currentLocation", ["StardewValley.Character::facingDirection"] = "FacingDirection", ["StardewValley.Character::name"] = "Name", ["StardewValley.Character::position"] = "Position", ["StardewValley.Character::scale"] = "Scale", ["StardewValley.Character::speed"] = "Speed", ["StardewValley.Character::sprite"] = "Sprite", // Chest ["StardewValley.Objects.Chest::tint"] = "Tint", // Farmer ["StardewValley.Farmer::houseUpgradeLevel"] = "HouseUpgradeLevel", ["StardewValley.Farmer::isMale"] = "IsMale", ["StardewValley.Farmer::items"] = "Items", ["StardewValley.Farmer::magneticRadius"] = "MagneticRadius", ["StardewValley.Farmer::stamina"] = "Stamina", ["StardewValley.Farmer::uniqueMultiplayerID"] = "UniqueMultiplayerID", ["StardewValley.Farmer::usingTool"] = "UsingTool", // Forest ["StardewValley.Locations.Forest::netTravelingMerchantDay"] = "travelingMerchantDay", ["StardewValley.Locations.Forest::netLog"] = "log", // FruitTree ["StardewValley.TerrainFeatures.FruitTree::greenHouseTileTree"] = "GreenHouseTileTree", ["StardewValley.TerrainFeatures.FruitTree::greenHouseTree"] = "GreenHouseTree", // GameLocation ["StardewValley.GameLocation::isFarm"] = "IsFarm", ["StardewValley.GameLocation::isOutdoors"] = "IsOutdoors", ["StardewValley.GameLocation::lightLevel"] = "LightLevel", ["StardewValley.GameLocation::name"] = "Name", // Item ["StardewValley.Item::category"] = "Category", ["StardewValley.Item::netName"] = "Name", ["StardewValley.Item::parentSheetIndex"] = "ParentSheetIndex", ["StardewValley.Item::specialVariable"] = "SpecialVariable", // Junimo ["StardewValley.Characters.Junimo::eventActor"] = "EventActor", // LightSource ["StardewValley.LightSource::identifier"] = "Identifier", // Monster ["StardewValley.Monsters.Monster::damageToFarmer"] = "DamageToFarmer", ["StardewValley.Monsters.Monster::experienceGained"] = "ExperienceGained", ["StardewValley.Monsters.Monster::health"] = "Health", ["StardewValley.Monsters.Monster::maxHealth"] = "MaxHealth", ["StardewValley.Monsters.Monster::netFocusedOnFarmers"] = "focusedOnFarmers", ["StardewValley.Monsters.Monster::netWildernessFarmMonster"] = "wildernessFarmMonster", ["StardewValley.Monsters.Monster::slipperiness"] = "Slipperiness", // NPC ["StardewValley.NPC::age"] = "Age", ["StardewValley.NPC::birthday_Day"] = "Birthday_Day", ["StardewValley.NPC::birthday_Season"] = "Birthday_Season", ["StardewValley.NPC::breather"] = "Breather", ["StardewValley.NPC::defaultMap"] = "DefaultMap", ["StardewValley.NPC::gender"] = "Gender", ["StardewValley.NPC::hideShadow"] = "HideShadow", ["StardewValley.NPC::isInvisible"] = "IsInvisible", ["StardewValley.NPC::isWalkingTowardPlayer"] = "IsWalkingTowardPlayer", ["StardewValley.NPC::manners"] = "Manners", ["StardewValley.NPC::optimism"] = "Optimism", ["StardewValley.NPC::socialAnxiety"] = "SocialAnxiety", // Object ["StardewValley.Object::canBeGrabbed"] = "CanBeGrabbed", ["StardewValley.Object::canBeSetDown"] = "CanBeSetDown", ["StardewValley.Object::edibility"] = "Edibility", ["StardewValley.Object::flipped"] = "Flipped", ["StardewValley.Object::fragility"] = "Fragility", ["StardewValley.Object::hasBeenPickedUpByFarmer"] = "HasBeenPickedUpByFarmer", ["StardewValley.Object::isHoedirt"] = "IsHoeDirt", ["StardewValley.Object::isOn"] = "IsOn", ["StardewValley.Object::isRecipe"] = "IsRecipe", ["StardewValley.Object::isSpawnedObject"] = "IsSpawnedObject", ["StardewValley.Object::minutesUntilReady"] = "MinutesUntilReady", ["StardewValley.Object::netName"] = "name", ["StardewValley.Object::price"] = "Price", ["StardewValley.Object::quality"] = "Quality", ["StardewValley.Object::scale"] = "Scale", ["StardewValley.Object::stack"] = "Stack", ["StardewValley.Object::tileLocation"] = "TileLocation", ["StardewValley.Object::type"] = "Type", // Projectile ["StardewValley.Projectiles.Projectile::ignoreLocationCollision"] = "IgnoreLocationCollision", // Tool ["StardewValley.Tool::currentParentTileIndex"] = "CurrentParentTileIndex", ["StardewValley.Tool::indexOfMenuItemView"] = "IndexOfMenuItemView", ["StardewValley.Tool::initialParentTileIndex"] = "InitialParentTileIndex", ["StardewValley.Tool::instantUse"] = "InstantUse", ["StardewValley.Tool::netName"] = "BaseName", ["StardewValley.Tool::stackable"] = "Stackable", ["StardewValley.Tool::upgradeLevel"] = "UpgradeLevel" }; /// Describes the diagnostic rule covered by the analyzer. private readonly IDictionary Rules = new Dictionary { ["AvoidImplicitNetFieldCast"] = new DiagnosticDescriptor( id: "AvoidImplicitNetFieldCast", title: "Netcode types shouldn't be implicitly converted", messageFormat: "This implicitly converts '{0}' from {1} to {2}, but {1} has unintuitive implicit conversion rules. Consider comparing against the actual value instead to avoid bugs. See https://smapi.io/buildmsg/avoid-implicit-net-field-cast for details.", category: "SMAPI.CommonErrors", defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: true, helpLinkUri: "https://smapi.io/buildmsg/avoid-implicit-net-field-cast" ), ["AvoidNetField"] = new DiagnosticDescriptor( id: "AvoidNetField", title: "Avoid Netcode types when possible", messageFormat: "'{0}' is a {1} field; consider using the {2} property instead. See https://smapi.io/buildmsg/avoid-net-field for details.", category: "SMAPI.CommonErrors", defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: true, helpLinkUri: "https://smapi.io/buildmsg/avoid-net-field" ) }; /********* ** Accessors *********/ /// The descriptors for the diagnostics that this analyzer is capable of producing. public override ImmutableArray SupportedDiagnostics { get; } /********* ** Public methods *********/ /// Construct an instance. public NetFieldAnalyzer() { this.SupportedDiagnostics = ImmutableArray.CreateRange(this.Rules.Values); } /// Called once at session start to register actions in the analysis context. /// The analysis context. public override void Initialize(AnalysisContext context) { context.RegisterSyntaxNodeAction( this.AnalyzeMemberAccess, SyntaxKind.SimpleMemberAccessExpression, SyntaxKind.ConditionalAccessExpression ); } /********* ** Private methods *********/ /// Analyse a syntax node and add a diagnostic message if it references a net field when there's a non-net equivalent available. /// The analysis context. private void AnalyzeMemberAccess(SyntaxNodeAnalysisContext context) { try { // get member access info if (!AnalyzerUtilities.GetMemberInfo(context.Node, context.SemanticModel, out ITypeSymbol declaringType, out TypeInfo memberType, out string memberName)) return; if (!this.IsNetType(memberType.Type)) return; // warn: use property wrapper if available foreach (ITypeSymbol type in AnalyzerUtilities.GetConcreteTypes(declaringType)) { if (this.NetFieldWrapperProperties.TryGetValue($"{type}::{memberName}", out string suggestedPropertyName)) { context.ReportDiagnostic(Diagnostic.Create(this.Rules["AvoidNetField"], context.Node.GetLocation(), context.Node, memberType.Type.Name, suggestedPropertyName)); return; } } // warn: implicit conversion if (this.IsInvalidConversion(memberType)) context.ReportDiagnostic(Diagnostic.Create(this.Rules["AvoidImplicitNetFieldCast"], context.Node.GetLocation(), context.Node, memberType.Type.Name, memberType.ConvertedType)); } catch (Exception ex) { throw new InvalidOperationException($"Failed processing expression: '{context.Node}'. Exception details: {ex.ToString().Replace('\r', ' ').Replace('\n', ' ')}"); } } /// Get whether a net field was converted in an error-prone way. /// The member access type info. private bool IsInvalidConversion(TypeInfo typeInfo) { // no conversion if (!this.IsNetType(typeInfo.Type) || this.IsNetType(typeInfo.ConvertedType)) return false; // list conversion to an implemented interface is OK if (AnalyzerUtilities.GetConcreteTypes(typeInfo.Type).Any(p => p.ToString().StartsWith(this.NetListTypeFullName))) // StartsWith to ignore generics { string toType = typeInfo.ConvertedType.ToString(); if (toType.StartsWith(typeof(IEnumerable<>).Namespace) || toType == typeof(IEnumerable).FullName) return false; } // collection conversion to an implemented interface is OK if (AnalyzerUtilities.GetConcreteTypes(typeInfo.Type).Any(p => p.ToString().StartsWith(this.NetCollectionTypeFullName))) // StartsWith to ignore generics { string toType = typeInfo.ConvertedType.ToString(); if (toType.StartsWith(typeof(IEnumerable<>).Namespace) || toType == typeof(IEnumerable).FullName) return false; } // avoid any other conversions return true; } /// Get whether a type symbol references a Netcode type. /// The type symbol. private bool IsNetType(ITypeSymbol typeSymbol) { return typeSymbol?.ContainingNamespace?.Name == NetFieldAnalyzer.NetcodeNamespace; } } }