// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Collections.Generic;
using System.Diagnostics;
 
namespace Microsoft.Gen.Logging.Model;
 
/// <summary>
/// A single parameter to a logger method.
/// </summary>
[DebuggerDisplay("{ParameterName}")]
internal sealed class LoggingMethodParameter
{
    public string ParameterName = string.Empty;
    public string TagName = string.Empty;
    public string Type = string.Empty;
    public string? Qualifier;
    public bool NeedsAtSign;
    public bool IsLogger;
    public bool IsException;
    public bool IsLogLevel;
    public bool IsEnumerable;
    public bool IsNullable;
    public bool IsReference;
    public bool ImplementsIConvertible;
    public bool ImplementsIFormattable;
    public bool ImplementsISpanFormattable;
    public bool HasCustomToString;
    public bool SkipNullProperties;
    public bool OmitReferenceName;
    public bool UsedAsTemplate;
    public HashSet<string> ClassificationAttributeTypes = [];
    public List<LoggingProperty> Properties = [];
    public TagProvider? TagProvider;
 
    public string ParameterNameWithAtIfNeeded => NeedsAtSign ? "@" + ParameterName : ParameterName;
 
    public string PotentiallyNullableType
        => (IsReference && !IsNullable)
            ? Type + "?"
            : Type;
 
    // A parameter flagged as 'normal' is not going to be taken care of specially as an argument to ILogger.Log
    // but instead is supposed to be taken as a normal parameter.
    public bool IsNormalParameter => !IsLogger && !IsException && !IsLogLevel;
 
    public bool HasDataClassification => ClassificationAttributeTypes.Count > 0;
    public bool HasProperties => Properties.Count > 0;
    public bool HasTagProvider => TagProvider is not null;
    public bool PotentiallyNull => (IsReference && !IsLogger) || IsNullable;
    public bool IsStringifiable => HasCustomToString || ImplementsIConvertible || ImplementsIFormattable || IsEnumerable;
}