source: trunk/HeuristicLab.ExtLibs/HeuristicLab.NRefactory/5.5.0/NRefactory.CSharp-5.5.0/Refactoring/CodeIssueProvider.cs @ 17578

// 
// IInspector.cs
//  
// Author:
//       Mike Krüger <mkrueger@xamarin.com>
// 
// Copyright (c) 2012 Xamarin <http://xamarin.com>
// 
// 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;
using System.Collections.Generic;
using System.Linq;

namespace ICSharpCode.NRefactory.CSharp.Refactoring
{
  /// <summary>
  /// The code issue provider gets a list of all code issues in a syntax tree.
  /// </summary>
  public abstract class CodeIssueProvider
  {
    SubIssueAttribute[] subIssueAttributes;

    public bool HasSubIssues {
      get {
        Initialize ();
        return subIssueAttributes.Length > 0;
      }
    }

    public IEnumerable<SubIssueAttribute> SubIssues {
      get {
        Initialize ();
        return subIssueAttributes;
      }
    }

    static readonly SubIssueAttribute[] emptyAttributes = new SubIssueAttribute[0];
    void Initialize()
    {
      if (subIssueAttributes != null)
        return;
      subIssueAttributes = GetType().GetCustomAttributes(typeof(SubIssueAttribute), false).OfType<SubIssueAttribute>().ToArray() ?? emptyAttributes;
    }

    /// <summary>
    /// Gets all code issues inside a syntax tree.
    /// </summary>
    /// <param name='context'>
    /// The refactoring context of the issues to get.
    /// </param>
    /// <param name='subIssue'>
    /// The name of the sub issue to run.
    /// </param>
    public virtual IEnumerable<CodeIssue> GetIssues (BaseRefactoringContext context, string subIssue = null)
    {
      return GetIssues(context);
    }
  }
}