mirror of https://github.com/icsharpcode/ILSpy.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
197 lines
6.4 KiB
197 lines
6.4 KiB
// |
|
// CodeAction.cs |
|
// |
|
// Author: |
|
// Mike Krüger <mkrueger@xamarin.com> |
|
// |
|
// Copyright (c) 2012 Xamarin Inc. (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 ICSharpCode.NRefactory.Refactoring; |
|
|
|
namespace ICSharpCode.NRefactory.CSharp.Refactoring |
|
{ |
|
/// <summary> |
|
/// A code action provides a code transformation with a description. |
|
/// </summary> |
|
public class CodeAction |
|
{ |
|
/// <summary> |
|
/// Gets the description. |
|
/// </summary> |
|
public string Description { |
|
get; |
|
private set; |
|
} |
|
|
|
/// <summary> |
|
/// Gets the code transformation. |
|
/// </summary> |
|
public Action<Script> Run { |
|
get; |
|
private set; |
|
} |
|
|
|
/// <summary> |
|
/// Gets the action start location. |
|
/// </summary> |
|
public TextLocation Start { |
|
get; |
|
private set; |
|
} |
|
|
|
/// <summary> |
|
/// Gets the action end location. |
|
/// </summary> |
|
public TextLocation End { |
|
get; |
|
private set; |
|
} |
|
|
|
/// <summary> |
|
/// This property is used to identify which actions are "siblings", ie which actions |
|
/// are the same kind of fix. This is used to group issues when batch fixing them. |
|
/// </summary> |
|
/// <remarks> |
|
/// Although the type is <see cref="object"/>, there is a restriction: The instance |
|
/// used must behave well as a key (for instance in a hash table). Additionaly, this |
|
/// value must be independent of the specific <see cref="CodeIssueProvider"/> instance |
|
/// which created it. In other words two different instances of the same issue provider |
|
/// implementation should use the same sibling keys for the same kinds of issues. |
|
/// </remarks> |
|
/// <value>The non-null sibling key if this type of action is batchable, null otherwise.</value> |
|
public object SiblingKey { |
|
get; |
|
private set; |
|
} |
|
|
|
Severity severity = Severity.Suggestion; |
|
|
|
/// <summary> |
|
/// Gets or sets the severity of the code action. |
|
/// Actions are sorted according to their Severity. |
|
/// </summary> |
|
/// <value>The severity.</value> |
|
public Severity Severity { |
|
get { |
|
return severity; |
|
} |
|
set { |
|
severity = value; |
|
} |
|
} |
|
|
|
const string defaultSiblingKey = "default"; |
|
|
|
/// <summary> |
|
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeAction"/> class, |
|
/// using a non-null default value for <see cref="SiblingKey"/>. |
|
/// </summary> |
|
/// <param name='description'> |
|
/// The description. |
|
/// </param> |
|
/// <param name='action'> |
|
/// The code transformation. |
|
/// </param> |
|
/// <param name='astNode'> |
|
/// A node that specifies the start/end positions for the code action. |
|
/// </param> |
|
public CodeAction (string description, Action<Script> action, AstNode astNode) |
|
: this (description, action, astNode, defaultSiblingKey) |
|
{ |
|
} |
|
|
|
/// <summary> |
|
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeAction"/> class. |
|
/// </summary> |
|
/// <param name='description'> |
|
/// The description. |
|
/// </param> |
|
/// <param name='action'> |
|
/// The code transformation. |
|
/// </param> |
|
/// <param name='astNode'> |
|
/// A node that specifies the start/end positions for the code action. |
|
/// </param> |
|
/// <param name="siblingKey> |
|
/// The key used to associate this action with other actions that should be fixed together in batch mode. |
|
/// </param> |
|
public CodeAction (string description, Action<Script> action, AstNode astNode, object siblingKey) |
|
{ |
|
if (action == null) |
|
throw new ArgumentNullException ("action"); |
|
if (description == null) |
|
throw new ArgumentNullException ("description"); |
|
if (astNode == null) |
|
throw new ArgumentNullException("astNode"); |
|
Description = description; |
|
Run = action; |
|
Start = astNode.StartLocation; |
|
End = astNode.EndLocation; |
|
SiblingKey = siblingKey; |
|
} |
|
|
|
/// <summary> |
|
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeAction"/> class, |
|
/// using a non-null default value for <see cref="SiblingKey"/>. |
|
/// </summary> |
|
/// <param name='description'> |
|
/// The description. |
|
/// </param> |
|
/// <param name='action'> |
|
/// The code transformation. |
|
/// </param> |
|
/// <param name='start'>Start position for the code action.</param> |
|
/// <param name='end'>End position for the code action.</param> |
|
public CodeAction (string description, Action<Script> action, TextLocation start, TextLocation end) |
|
: this (description, action, start, end, defaultSiblingKey) |
|
{ |
|
SiblingKey = defaultSiblingKey; |
|
} |
|
|
|
/// <summary> |
|
/// Initializes a new instance of the <see cref="ICSharpCode.NRefactory.CSharp.Refactoring.CodeAction"/> class. |
|
/// </summary> |
|
/// <param name='description'> |
|
/// The description. |
|
/// </param> |
|
/// <param name='action'> |
|
/// The code transformation. |
|
/// </param> |
|
/// <param name='start'>Start position for the code action.</param> |
|
/// <param name='end'>End position for the code action.</param> |
|
/// <param name="siblingKey> |
|
/// The key used to associate this action with other actions that should be fixed together in batch mode. |
|
/// </param> |
|
public CodeAction (string description, Action<Script> action, TextLocation start, TextLocation end, object siblingKey) |
|
{ |
|
if (action == null) |
|
throw new ArgumentNullException ("action"); |
|
if (description == null) |
|
throw new ArgumentNullException ("description"); |
|
Description = description; |
|
Run = action; |
|
this.Start = start; |
|
this.End = end; |
|
SiblingKey = siblingKey; |
|
} |
|
} |
|
} |
|
|
|
|