Skip to content
This repository
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

file 180 lines (165 sloc) 5.995 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
//
// InspectionIssue.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;
using ICSharpCode.NRefactory.Refactoring;

namespace ICSharpCode.NRefactory.CSharp.Refactoring
{
/// <summary>
/// A code issue marks a region of text with an issue and can provide solution actions for this issue.
/// </summary>
public class CodeIssue
{
/// <summary>
/// Gets the description of the issue.
/// </summary>
public string Description {
get;
private set;
}

/// <summary>
/// Gets the issue start location.
/// </summary>
public TextLocation Start {
get;
private set;
}

/// <summary>
/// Gets the issue end location.
/// </summary>
public TextLocation End {
get;
private set;
}

/// <summary>
/// Gets a list of potential solutions for the issue.
/// </summary>
public IList<CodeAction> Actions {
get;
private set;
}

List<Type> actionProvider = new List<Type>();
public List<Type> ActionProvider {
get {
return actionProvider;
}
set {
actionProvider = value;
}
}

/// <summary>
/// Gets or sets the Issue marker which should be used to mark this issue in the editor.
/// It's up to the editor implementation if and how this info is used.
/// </summary>
public IssueMarker IssueMarker {
get;
set;
}

/// <summary>
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeIssue"/> class.
/// </summary>
public CodeIssue(TextLocation start, TextLocation end, string issueDescription)
{
if (issueDescription == null)
throw new ArgumentNullException("issueDescription");
Description = issueDescription;
Start = start;
End = end;
Actions = EmptyList<CodeAction>.Instance;
IssueMarker = IssueMarker.WavedLine;
}

/// <summary>
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeIssue"/> class.
/// </summary>
public CodeIssue(TextLocation start, TextLocation end, string issueDescription, IEnumerable<CodeAction> actions) : this(start, end, issueDescription)
{
if (actions != null)
Actions = actions.ToArray();
}

/// <summary>
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeIssue"/> class.
/// </summary>
public CodeIssue(TextLocation start, TextLocation end, string issueDescription, params CodeAction[] actions) : this(start, end, issueDescription)
{
if (actions != null)
Actions = actions;
}

/// <summary>
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeIssue"/> class.
/// </summary>
public CodeIssue(TextLocation start, TextLocation end, string issueDescription, string actionDescription, Action<Script> fix) : this(start, end, issueDescription)
{
if (actionDescription == null)
throw new ArgumentNullException("actionDescription");
if (fix == null)
throw new ArgumentNullException("fix");
this.Actions = new [] { new CodeAction(actionDescription, fix, start, end) };
}

/// <summary>
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeIssue"/> class.
/// </summary>
public CodeIssue(AstNode node, string issueDescription)
{
if (node == null)
throw new ArgumentNullException("node");
if (issueDescription == null)
throw new ArgumentNullException("issueDescription");
Description = issueDescription;
Start = node.StartLocation;
End = node.EndLocation;
Actions = EmptyList<CodeAction>.Instance;
IssueMarker = IssueMarker.WavedLine;
}

/// <summary>
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeIssue"/> class.
/// </summary>
public CodeIssue(AstNode node, string issueDescription, IEnumerable<CodeAction> actions) : this(node, issueDescription)
{
if (actions != null)
Actions = actions.ToArray();
}

/// <summary>
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeIssue"/> class.
/// </summary>
public CodeIssue(AstNode node, string issueDescription, params CodeAction[] actions) : this(node, issueDescription)
{
if (actions != null)
Actions = actions;
}

/// <summary>
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeIssue"/> class.
/// </summary>
public CodeIssue(AstNode node, string issueDescription, string actionDescription, Action<Script> fix) : this(node, issueDescription)
{
if (actionDescription == null)
throw new ArgumentNullException("actionDescription");
if (fix == null)
throw new ArgumentNullException("fix");
this.Actions = new [] { new CodeAction(actionDescription, fix, node) };
}

}
}
Something went wrong with that request. Please try again.