ILSpy/ICSharpCode.Decompiler/IL/Instructions/IfInstruction.cs

#nullable enable
// Copyright (c) 2014 Daniel Grunwald
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

using System.Diagnostics;

using ICSharpCode.Decompiler.TypeSystem;

namespace ICSharpCode.Decompiler.IL
{
	/// <summary>If statement / conditional expression. <c>if (condition) trueExpr else falseExpr</c></summary>
	/// <remarks>
	/// The condition must return StackType.I4, use comparison instructions like Ceq to check if other types are non-zero.
	///
	/// If the condition evaluates to non-zero, the TrueInst is executed.
	/// If the condition evaluates to zero, the FalseInst is executed.
	/// The return value of the IfInstruction is the return value of the TrueInst or FalseInst.
	/// 
	/// IfInstruction is also used to represent logical operators:
	///   "a || b" ==> if (a) (ldc.i4 1) else (b)
	///   "a &amp;&amp; b" ==> if (a) (b) else (ldc.i4 0)
	///   "a ? b : c" ==> if (a) (b) else (c)
	/// </remarks>
	partial class IfInstruction : ILInstruction
	{
		// null means void
		IType? csharpType;

		public IType? CSharpType {
			get => csharpType;
			set {
				Debug.Assert(this.ResultType == (value?.GetStackType() ?? StackType.Void));
				csharpType = value;
			}
		}

		public IfInstruction(ILInstruction condition, ILInstruction trueInst,
			ILInstruction? falseInst = null, IType? resultType = null) : base(OpCode.IfInstruction)
		{
			this.Condition = condition;
			this.TrueInst = trueInst;
			falseInst ??= new Nop();
			this.FalseInst = falseInst;
			this.csharpType = resultType;
			Debug.Assert(condition.ResultType == StackType.I4);
			Debug.Assert(trueInst.ResultType == this.ResultType
				|| trueInst.HasDirectFlag(InstructionFlags.EndPointUnreachable));
			Debug.Assert(falseInst.ResultType == this.ResultType
				|| falseInst.HasDirectFlag(InstructionFlags.EndPointUnreachable));
		}

		public static IfInstruction LogicAnd(ILInstruction lhs, ILInstruction rhs, ICompilation compilation)
		{
			Debug.Assert(lhs.ResultType == StackType.I4);
			Debug.Assert(rhs.ResultType == StackType.I4);
			return new IfInstruction(lhs, rhs, new LdcI4(0), rhs.InferType(compilation));
		}

		public static IfInstruction LogicOr(ILInstruction lhs, ILInstruction rhs, ICompilation compilation)
		{
			return new IfInstruction(lhs, new LdcI4(1), rhs, rhs.InferType(compilation));
		}

		internal override void CheckInvariant(ILPhase phase, ICompilation compilation)
		{
			base.CheckInvariant(phase, compilation);
			Debug.Assert(condition.ResultType == StackType.I4);
			Debug.Assert(trueInst.ResultType == this.ResultType
				|| trueInst.HasDirectFlag(InstructionFlags.EndPointUnreachable));
			Debug.Assert(falseInst.ResultType == this.ResultType
				|| falseInst.HasDirectFlag(InstructionFlags.EndPointUnreachable));
		}

		public override StackType ResultType {
			get {
				if (csharpType != null)
					return csharpType.GetStackType();
				return StackType.Void;
			}
		}
		public override IType InferType(ICompilation compilation)
		{
			if (csharpType != null)
				return csharpType;
			return compilation.FindType(KnownTypeCode.Void);
		}
		public override InstructionFlags DirectFlags => InstructionFlags.ControlFlow;

		protected override InstructionFlags ComputeFlags()
		{
			return InstructionFlags.ControlFlow | condition.Flags | SemanticHelper.CombineBranches(trueInst.Flags, falseInst.Flags);
		}

		protected override void WriteToCore(ITextOutput output, ILAstWritingOptions options)
		{
			WriteILRange(output, options);
			if (options.UseLogicOperationSugar
				&& csharpType != null && csharpType.IsKnownType(KnownTypeCode.Boolean))
			{
				if (MatchLogicAnd(out var lhs, out var rhs))
				{
					output.Write("logic.and(");
					lhs.WriteTo(output, options);
					output.Write(", ");
					rhs.WriteTo(output, options);
					output.Write(')');
					return;
				}
				if (MatchLogicOr(out lhs, out rhs))
				{
					output.Write("logic.or(");
					lhs.WriteTo(output, options);
					output.Write(", ");
					rhs.WriteTo(output, options);
					output.Write(')');
					return;
				}
			}
			output.Write(OpCode);
			if (csharpType != null)
			{
				output.Write(" [");
				output.Write(csharpType.ReflectionName);
				output.Write(']');
			}
			output.Write(" (");
			condition.WriteTo(output, options);
			output.Write(") ");
			trueInst.WriteTo(output, options);
			if (falseInst.OpCode != OpCode.Nop)
			{
				output.Write(" else ");
				falseInst.WriteTo(output, options);
			}
		}

		/// <summary>
		/// Gets whether the input instruction occurs in a context where it is being compared with 0.
		/// </summary>
		internal static bool IsInConditionSlot(ILInstruction inst)
		{
			var slot = inst.SlotInfo;
			if (slot == IfInstruction.ConditionSlot)
				return true;
			if (slot == IfInstruction.TrueInstSlot || slot == IfInstruction.FalseInstSlot || slot == NullCoalescingInstruction.FallbackInstSlot)
				return IsInConditionSlot(inst.Parent!);
			if (inst.Parent is Comp comp)
			{
				if (comp.Left == inst && comp.Right.MatchLdcI4(0))
					return true;
				if (comp.Right == inst && comp.Left.MatchLdcI4(0))
					return true;
			}
			return false;
		}
	}
}