Skimmer.cs

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System;
using System.Collections.Generic;
using System.Resources;

namespace Microsoft.CodeAnalysis.Sarif.Driver
{
    public abstract class Skimmer<TContext> : ReportingDescriptor
    {
        public Skimmer()
        {
            this.Options = new Dictionary<string, string>();
            this.DefaultConfiguration = new ReportingConfiguration
            {
                Level = FailureLevel.Warning,
                Enabled = this.EnabledByDefault
            };
        }

        private IDictionary<string, MultiformatMessageString> multiformatMessageStrings;

        protected virtual ResourceManager ResourceManager => null;

        protected virtual ICollection<string> MessageResourceNames => throw new NotImplementedException();

        public virtual bool EnabledByDefault => true;

        public virtual ReportingDescriptorReference ReportingDescriptorReference { get; set; }

        public virtual ISet<string> IncompatibleRuleIds { get; internal set; }

        public override IDictionary<string, MultiformatMessageString> MessageStrings
        {
            get
            {
                if (this.multiformatMessageStrings == null)
                {
                    this.multiformatMessageStrings = InitializeMultiformatMessageStrings();
                }
                return this.multiformatMessageStrings;
            }
        }

        private Dictionary<string, MultiformatMessageString> InitializeMultiformatMessageStrings()
        {
            return (ResourceManager == null) ? null
                : RuleUtilities.BuildDictionary(ResourceManager, MessageResourceNames, ruleId: Id);
        }

        public int ExtensionIndex { get; set; }

        public override string Id => throw new InvalidOperationException($"The {nameof(Id)} property must be overridden in the SkimmerBase-derived class.");

        public override MultiformatMessageString FullDescription => throw new InvalidOperationException($"The {nameof(FullDescription)} property must be overridden in the SkimmerBase-derived class.");

        public override MultiformatMessageString ShortDescription => null;

        public override string Name => this.GetType().Name;

        public IDictionary<string, string> Options { get; }

        public virtual HashSet<RuleKind> RuleKinds => new HashSet<RuleKind>(new[] { RuleKind.Sarif });

        public virtual void Initialize(TContext context) { }

        public virtual SupportedPlatform SupportedPlatforms => SupportedPlatform.All;

        public virtual AnalysisApplicability CanAnalyze(TContext context, out string reasonIfNotApplicable)
        {
            reasonIfNotApplicable = null;
            return AnalysisApplicability.ApplicableToSpecifiedTarget;
        }

        public abstract void Analyze(TContext context);

        protected static string MakeAnalyzerMoniker(string id, string name) => $"{id}.{name}";
    }
}