using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
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";
/// 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
{
["SMAPI001"] = new DiagnosticDescriptor(
id: "SMAPI001",
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/smapi001 for details.",
category: "SMAPI.CommonErrors",
defaultSeverity: DiagnosticSeverity.Warning,
isEnabledByDefault: true,
helpLinkUri: "https://smapi.io/buildmsg/smapi001"
),
["SMAPI002"] = new DiagnosticDescriptor(
id: "SMAPI002",
title: "Avoid Netcode types when possible",
messageFormat: "'{0}' is a {1} field; consider using the {2} property instead. See https://smapi.io/buildmsg/smapi002 for details.",
category: "SMAPI.CommonErrors",
defaultSeverity: DiagnosticSeverity.Warning,
isEnabledByDefault: true,
helpLinkUri: "https://smapi.io/buildmsg/smapi001"
)
};
/*********
** 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)
{
// SMAPI002: avoid net fields if possible
context.RegisterSyntaxNodeAction(
this.AnalyzeAvoidableNetField,
SyntaxKind.SimpleMemberAccessExpression
);
// SMAPI001: avoid implicit net field conversion
context.RegisterSyntaxNodeAction(
this.AnalyseNetFieldConversions,
SyntaxKind.EqualsExpression,
SyntaxKind.NotEqualsExpression,
SyntaxKind.GreaterThanExpression,
SyntaxKind.GreaterThanOrEqualExpression,
SyntaxKind.LessThanExpression,
SyntaxKind.LessThanOrEqualExpression
);
}
/*********
** 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 AnalyzeAvoidableNetField(SyntaxNodeAnalysisContext context)
{
try
{
// check member type
MemberAccessExpressionSyntax node = (MemberAccessExpressionSyntax)context.Node;
TypeInfo memberType = context.SemanticModel.GetTypeInfo(node);
if (!this.IsNetType(memberType.Type))
return;
// get reference info
ITypeSymbol declaringType = context.SemanticModel.GetTypeInfo(node.Expression).Type;
string propertyName = node.Name.Identifier.Text;
// suggest replacement
for (ITypeSymbol type = declaringType; type != null; type = type.BaseType)
{
if (this.NetFieldWrapperProperties.TryGetValue($"{type}::{propertyName}", out string suggestedPropertyName))
{
context.ReportDiagnostic(Diagnostic.Create(this.Rules["SMAPI002"], context.Node.GetLocation(), node, memberType.Type.Name, suggestedPropertyName));
break;
}
}
}
catch (Exception ex)
{
throw new InvalidOperationException($"Failed processing expression: '{context.Node}'. Exception details: {ex.ToString().Replace('\r', ' ').Replace('\n', ' ')}");
}
}
/// Analyse a syntax node and add a diagnostic message if it implicitly converts a net field.
/// The analysis context.
private void AnalyseNetFieldConversions(SyntaxNodeAnalysisContext context)
{
try
{
BinaryExpressionSyntax binaryExpression = (BinaryExpressionSyntax)context.Node;
foreach (var pair in new[] { Tuple.Create(binaryExpression.Left, binaryExpression.Right), Tuple.Create(binaryExpression.Right, binaryExpression.Left) })
{
// get node info
ExpressionSyntax curExpression = pair.Item1; // the side of the comparison being examined
ExpressionSyntax otherExpression = pair.Item2; // the other side
TypeInfo typeInfo = context.SemanticModel.GetTypeInfo(curExpression);
if (!this.IsNetType(typeInfo.Type))
continue;
// warn for implicit conversion
if (!this.IsNetType(typeInfo.ConvertedType))
{
context.ReportDiagnostic(Diagnostic.Create(this.Rules["SMAPI001"], context.Node.GetLocation(), curExpression, typeInfo.Type.Name, typeInfo.ConvertedType));
break;
}
// warn for comparison to null
// An expression like `building.indoors != null` will sometimes convert `building.indoors` to NetFieldBase instead of object before comparison. Haven't reproduced this in unit tests yet.
Optional