You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
939 lines
33 KiB
C#
939 lines
33 KiB
C#
|
|
#if !UNITY_5 && !UNITY_5_3_OR_NEWER && UNITY_EDITOR
|
|
|
|
using System;
|
|
using System.Diagnostics;
|
|
|
|
#pragma warning disable 1591
|
|
// ReSharper disable UnusedMember.Global
|
|
// ReSharper disable MemberCanBePrivate.Global
|
|
// ReSharper disable UnusedAutoPropertyAccessor.Global
|
|
// ReSharper disable IntroduceOptionalParameters.Global
|
|
// ReSharper disable MemberCanBeProtected.Global
|
|
// ReSharper disable InconsistentNaming
|
|
|
|
namespace JetBrains.Annotations
|
|
{
|
|
/// <summary>
|
|
/// Indicates that the value of the marked element could be <c>null</c> sometimes,
|
|
/// so the check for <c>null</c> is necessary before its usage
|
|
/// </summary>
|
|
/// <example><code>
|
|
/// [CanBeNull] public object Test() { return null; }
|
|
/// public void UseTest() {
|
|
/// var p = Test();
|
|
/// var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
|
|
/// }
|
|
/// </code></example>
|
|
[AttributeUsage(
|
|
AttributeTargets.Method | AttributeTargets.Parameter | AttributeTargets.Property |
|
|
AttributeTargets.Delegate | AttributeTargets.Field | AttributeTargets.Event)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class CanBeNullAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that the value of the marked element could never be <c>null</c>
|
|
/// </summary>
|
|
/// <example><code>
|
|
/// [NotNull] public object Foo() {
|
|
/// return null; // Warning: Possible 'null' assignment
|
|
/// }
|
|
/// </code></example>
|
|
[AttributeUsage(
|
|
AttributeTargets.Method | AttributeTargets.Parameter | AttributeTargets.Property |
|
|
AttributeTargets.Delegate | AttributeTargets.Field | AttributeTargets.Event)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class NotNullAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that collection or enumerable value does not contain null elements
|
|
/// </summary>
|
|
[AttributeUsage(
|
|
AttributeTargets.Method | AttributeTargets.Parameter | AttributeTargets.Property |
|
|
AttributeTargets.Delegate | AttributeTargets.Field)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class ItemNotNullAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that collection or enumerable value can contain null elements
|
|
/// </summary>
|
|
[AttributeUsage(
|
|
AttributeTargets.Method | AttributeTargets.Parameter | AttributeTargets.Property |
|
|
AttributeTargets.Delegate | AttributeTargets.Field)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class ItemCanBeNullAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that the marked method builds string by format pattern and (optional) arguments.
|
|
/// Parameter, which contains format string, should be given in constructor. The format string
|
|
/// should be in <see cref="string.Format(IFormatProvider,string,object[])"/>-like form
|
|
/// </summary>
|
|
/// <example><code>
|
|
/// [StringFormatMethod("message")]
|
|
/// public void ShowError(string message, params object[] args) { /* do something */ }
|
|
/// public void Foo() {
|
|
/// ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
|
|
/// }
|
|
/// </code></example>
|
|
[AttributeUsage(
|
|
AttributeTargets.Constructor | AttributeTargets.Method | AttributeTargets.Delegate)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class StringFormatMethodAttribute : Attribute
|
|
{
|
|
/// <param name="formatParameterName">
|
|
/// Specifies which parameter of an annotated method should be treated as format-string
|
|
/// </param>
|
|
public StringFormatMethodAttribute(string formatParameterName)
|
|
{
|
|
FormatParameterName = formatParameterName;
|
|
}
|
|
|
|
public string FormatParameterName { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// For a parameter that is expected to be one of the limited set of values.
|
|
/// Specify fields of which type should be used as values for this parameter.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.Field)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class ValueProviderAttribute : Attribute
|
|
{
|
|
public ValueProviderAttribute(string name)
|
|
{
|
|
Name = name;
|
|
}
|
|
|
|
[NotNull]
|
|
public string Name { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Indicates that the function argument should be string literal and match one
|
|
/// of the parameters of the caller function. For example, ReSharper annotates
|
|
/// the parameter of <see cref="System.ArgumentNullException"/>
|
|
/// </summary>
|
|
/// <example><code>
|
|
/// public void Foo(string param) {
|
|
/// if (param == null)
|
|
/// throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
|
|
/// }
|
|
/// </code></example>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class InvokerParameterNameAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that the method is contained in a type that implements
|
|
/// <c>System.ComponentModel.INotifyPropertyChanged</c> interface and this method
|
|
/// is used to notify that some property value changed
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The method should be non-static and conform to one of the supported signatures:
|
|
/// <list>
|
|
/// <item><c>NotifyChanged(string)</c></item>
|
|
/// <item><c>NotifyChanged(params string[])</c></item>
|
|
/// <item><c>NotifyChanged{T}(Expression{Func{T}})</c></item>
|
|
/// <item><c>NotifyChanged{T,U}(Expression{Func{T,U}})</c></item>
|
|
/// <item><c>SetProperty{T}(ref T, T, string)</c></item>
|
|
/// </list>
|
|
/// </remarks>
|
|
/// <example><code>
|
|
/// public class Foo : INotifyPropertyChanged {
|
|
/// public event PropertyChangedEventHandler PropertyChanged;
|
|
/// [NotifyPropertyChangedInvocator]
|
|
/// protected virtual void NotifyChanged(string propertyName) { ... }
|
|
///
|
|
/// private string _name;
|
|
/// public string Name {
|
|
/// get { return _name; }
|
|
/// set { _name = value; NotifyChanged("LastName"); /* Warning */ }
|
|
/// }
|
|
/// }
|
|
/// </code>
|
|
/// Examples of generated notifications:
|
|
/// <list>
|
|
/// <item><c>NotifyChanged("Property")</c></item>
|
|
/// <item><c>NotifyChanged(() => Property)</c></item>
|
|
/// <item><c>NotifyChanged((VM x) => x.Property)</c></item>
|
|
/// <item><c>SetProperty(ref myField, value, "Property")</c></item>
|
|
/// </list>
|
|
/// </example>
|
|
[AttributeUsage(AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class NotifyPropertyChangedInvocatorAttribute : Attribute
|
|
{
|
|
public NotifyPropertyChangedInvocatorAttribute() { }
|
|
public NotifyPropertyChangedInvocatorAttribute(string parameterName)
|
|
{
|
|
ParameterName = parameterName;
|
|
}
|
|
|
|
public string ParameterName { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Describes dependency between method input and output
|
|
/// </summary>
|
|
/// <syntax>
|
|
/// <p>Function Definition Table syntax:</p>
|
|
/// <list>
|
|
/// <item>FDT ::= FDTRow [;FDTRow]*</item>
|
|
/// <item>FDTRow ::= Input => Output | Output <= Input</item>
|
|
/// <item>Input ::= ParameterName: Value [, Input]*</item>
|
|
/// <item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item>
|
|
/// <item>Value ::= true | false | null | notnull | canbenull</item>
|
|
/// </list>
|
|
/// If method has single input parameter, it's name could be omitted.<br/>
|
|
/// Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same)
|
|
/// for method output means that the methos doesn't return normally.<br/>
|
|
/// <c>canbenull</c> annotation is only applicable for output parameters.<br/>
|
|
/// You can use multiple <c>[ContractAnnotation]</c> for each FDT row,
|
|
/// or use single attribute with rows separated by semicolon.<br/>
|
|
/// </syntax>
|
|
/// <examples><list>
|
|
/// <item><code>
|
|
/// [ContractAnnotation("=> halt")]
|
|
/// public void TerminationMethod()
|
|
/// </code></item>
|
|
/// <item><code>
|
|
/// [ContractAnnotation("halt <= condition: false")]
|
|
/// public void Assert(bool condition, string text) // regular assertion method
|
|
/// </code></item>
|
|
/// <item><code>
|
|
/// [ContractAnnotation("s:null => true")]
|
|
/// public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty()
|
|
/// </code></item>
|
|
/// <item><code>
|
|
/// // A method that returns null if the parameter is null,
|
|
/// // and not null if the parameter is not null
|
|
/// [ContractAnnotation("null => null; notnull => notnull")]
|
|
/// public object Transform(object data)
|
|
/// </code></item>
|
|
/// <item><code>
|
|
/// [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")]
|
|
/// public bool TryParse(string s, out Person result)
|
|
/// </code></item>
|
|
/// </list></examples>
|
|
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class ContractAnnotationAttribute : Attribute
|
|
{
|
|
public ContractAnnotationAttribute([NotNull] string contract)
|
|
: this(contract, false) { }
|
|
|
|
public ContractAnnotationAttribute([NotNull] string contract, bool forceFullStates)
|
|
{
|
|
Contract = contract;
|
|
ForceFullStates = forceFullStates;
|
|
}
|
|
|
|
public string Contract { get; private set; }
|
|
public bool ForceFullStates { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Indicates that marked element should be localized or not
|
|
/// </summary>
|
|
/// <example><code>
|
|
/// [LocalizationRequiredAttribute(true)]
|
|
/// public class Foo {
|
|
/// private string str = "my string"; // Warning: Localizable string
|
|
/// }
|
|
/// </code></example>
|
|
[AttributeUsage(AttributeTargets.All)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class LocalizationRequiredAttribute : Attribute
|
|
{
|
|
public LocalizationRequiredAttribute() : this(true) { }
|
|
public LocalizationRequiredAttribute(bool required)
|
|
{
|
|
Required = required;
|
|
}
|
|
|
|
public bool Required { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Indicates that the value of the marked type (or its derivatives)
|
|
/// cannot be compared using '==' or '!=' operators and <c>Equals()</c>
|
|
/// should be used instead. However, using '==' or '!=' for comparison
|
|
/// with <c>null</c> is always permitted.
|
|
/// </summary>
|
|
/// <example><code>
|
|
/// [CannotApplyEqualityOperator]
|
|
/// class NoEquality { }
|
|
/// class UsesNoEquality {
|
|
/// public void Test() {
|
|
/// var ca1 = new NoEquality();
|
|
/// var ca2 = new NoEquality();
|
|
/// if (ca1 != null) { // OK
|
|
/// bool condition = ca1 == ca2; // Warning
|
|
/// }
|
|
/// }
|
|
/// }
|
|
/// </code></example>
|
|
[AttributeUsage(
|
|
AttributeTargets.Interface | AttributeTargets.Class | AttributeTargets.Struct)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class CannotApplyEqualityOperatorAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// When applied to a target attribute, specifies a requirement for any type marked
|
|
/// with the target attribute to implement or inherit specific type or types.
|
|
/// </summary>
|
|
/// <example><code>
|
|
/// [BaseTypeRequired(typeof(IComponent)] // Specify requirement
|
|
/// public class ComponentAttribute : Attribute { }
|
|
/// [Component] // ComponentAttribute requires implementing IComponent interface
|
|
/// public class MyComponent : IComponent { }
|
|
/// </code></example>
|
|
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
|
|
[BaseTypeRequired(typeof(Attribute))]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class BaseTypeRequiredAttribute : Attribute
|
|
{
|
|
public BaseTypeRequiredAttribute([NotNull] Type baseType)
|
|
{
|
|
BaseType = baseType;
|
|
}
|
|
|
|
[NotNull]
|
|
public Type BaseType { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Indicates that the marked symbol is used implicitly
|
|
/// (e.g. via reflection, in external library), so this symbol
|
|
/// will not be marked as unused (as well as by other usage inspections)
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.All)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class UsedImplicitlyAttribute : Attribute
|
|
{
|
|
public UsedImplicitlyAttribute()
|
|
: this(ImplicitUseKindFlags.Default, ImplicitUseTargetFlags.Default) { }
|
|
|
|
public UsedImplicitlyAttribute(ImplicitUseKindFlags useKindFlags)
|
|
: this(useKindFlags, ImplicitUseTargetFlags.Default) { }
|
|
|
|
public UsedImplicitlyAttribute(ImplicitUseTargetFlags targetFlags)
|
|
: this(ImplicitUseKindFlags.Default, targetFlags) { }
|
|
|
|
public UsedImplicitlyAttribute(
|
|
ImplicitUseKindFlags useKindFlags, ImplicitUseTargetFlags targetFlags)
|
|
{
|
|
UseKindFlags = useKindFlags;
|
|
TargetFlags = targetFlags;
|
|
}
|
|
|
|
public ImplicitUseKindFlags UseKindFlags { get; private set; }
|
|
public ImplicitUseTargetFlags TargetFlags { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Should be used on attributes and causes ReSharper
|
|
/// to not mark symbols marked with such attributes as unused
|
|
/// (as well as by other usage inspections)
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Class | AttributeTargets.GenericParameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class MeansImplicitUseAttribute : Attribute
|
|
{
|
|
public MeansImplicitUseAttribute()
|
|
: this(ImplicitUseKindFlags.Default, ImplicitUseTargetFlags.Default) { }
|
|
|
|
public MeansImplicitUseAttribute(ImplicitUseKindFlags useKindFlags)
|
|
: this(useKindFlags, ImplicitUseTargetFlags.Default) { }
|
|
|
|
public MeansImplicitUseAttribute(ImplicitUseTargetFlags targetFlags)
|
|
: this(ImplicitUseKindFlags.Default, targetFlags) { }
|
|
|
|
public MeansImplicitUseAttribute(
|
|
ImplicitUseKindFlags useKindFlags, ImplicitUseTargetFlags targetFlags)
|
|
{
|
|
UseKindFlags = useKindFlags;
|
|
TargetFlags = targetFlags;
|
|
}
|
|
|
|
[UsedImplicitly]
|
|
public ImplicitUseKindFlags UseKindFlags { get; private set; }
|
|
[UsedImplicitly]
|
|
public ImplicitUseTargetFlags TargetFlags { get; private set; }
|
|
}
|
|
|
|
[Flags]
|
|
public enum ImplicitUseKindFlags
|
|
{
|
|
Default = Access | Assign | InstantiatedWithFixedConstructorSignature,
|
|
/// <summary>Only entity marked with attribute considered used</summary>
|
|
Access = 1,
|
|
/// <summary>Indicates implicit assignment to a member</summary>
|
|
Assign = 2,
|
|
/// <summary>
|
|
/// Indicates implicit instantiation of a type with fixed constructor signature.
|
|
/// That means any unused constructor parameters won't be reported as such.
|
|
/// </summary>
|
|
InstantiatedWithFixedConstructorSignature = 4,
|
|
/// <summary>Indicates implicit instantiation of a type</summary>
|
|
InstantiatedNoFixedConstructorSignature = 8,
|
|
}
|
|
|
|
/// <summary>
|
|
/// Specify what is considered used implicitly when marked
|
|
/// with <see cref="MeansImplicitUseAttribute"/> or <see cref="UsedImplicitlyAttribute"/>
|
|
/// </summary>
|
|
[Flags]
|
|
public enum ImplicitUseTargetFlags
|
|
{
|
|
Default = Itself,
|
|
Itself = 1,
|
|
/// <summary>Members of entity marked with attribute are considered used</summary>
|
|
Members = 2,
|
|
/// <summary>Entity marked with attribute and all its members considered used</summary>
|
|
WithMembers = Itself | Members
|
|
}
|
|
|
|
/// <summary>
|
|
/// This attribute is intended to mark publicly available API
|
|
/// which should not be removed and so is treated as used
|
|
/// </summary>
|
|
[MeansImplicitUse]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class PublicAPIAttribute : Attribute
|
|
{
|
|
public PublicAPIAttribute() { }
|
|
public PublicAPIAttribute([NotNull] string comment)
|
|
{
|
|
Comment = comment;
|
|
}
|
|
|
|
public string Comment { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tells code analysis engine if the parameter is completely handled
|
|
/// when the invoked method is on stack. If the parameter is a delegate,
|
|
/// indicates that delegate is executed while the method is executed.
|
|
/// If the parameter is an enumerable, indicates that it is enumerated
|
|
/// while the method is executed
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class InstantHandleAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that a method does not make any observable state changes.
|
|
/// The same as <c>System.Diagnostics.Contracts.PureAttribute</c>
|
|
/// </summary>
|
|
/// <example><code>
|
|
/// [Pure] private int Multiply(int x, int y) { return x * y; }
|
|
/// public void Foo() {
|
|
/// const int a = 2, b = 2;
|
|
/// Multiply(a, b); // Waring: Return value of pure method is not used
|
|
/// }
|
|
/// </code></example>
|
|
[AttributeUsage(AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class PureAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that a parameter is a path to a file or a folder within a web project.
|
|
/// Path can be relative or absolute, starting from web root (~)
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public class PathReferenceAttribute : Attribute
|
|
{
|
|
public PathReferenceAttribute() { }
|
|
public PathReferenceAttribute([PathReference] string basePath)
|
|
{
|
|
BasePath = basePath;
|
|
}
|
|
|
|
public string BasePath { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcAreaMasterLocationFormatAttribute : Attribute
|
|
{
|
|
public AspMvcAreaMasterLocationFormatAttribute(string format)
|
|
{
|
|
Format = format;
|
|
}
|
|
|
|
public string Format { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcAreaPartialViewLocationFormatAttribute : Attribute
|
|
{
|
|
public AspMvcAreaPartialViewLocationFormatAttribute(string format)
|
|
{
|
|
Format = format;
|
|
}
|
|
|
|
public string Format { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcAreaViewLocationFormatAttribute : Attribute
|
|
{
|
|
public AspMvcAreaViewLocationFormatAttribute(string format)
|
|
{
|
|
Format = format;
|
|
}
|
|
|
|
public string Format { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcMasterLocationFormatAttribute : Attribute
|
|
{
|
|
public AspMvcMasterLocationFormatAttribute(string format)
|
|
{
|
|
Format = format;
|
|
}
|
|
|
|
public string Format { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcPartialViewLocationFormatAttribute : Attribute
|
|
{
|
|
public AspMvcPartialViewLocationFormatAttribute(string format)
|
|
{
|
|
Format = format;
|
|
}
|
|
|
|
public string Format { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcViewLocationFormatAttribute : Attribute
|
|
{
|
|
public AspMvcViewLocationFormatAttribute(string format)
|
|
{
|
|
Format = format;
|
|
}
|
|
|
|
public string Format { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
|
/// is an MVC action. If applied to a method, the MVC action name is calculated
|
|
/// implicitly from the context. Use this attribute for custom wrappers similar to
|
|
/// <c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcActionAttribute : Attribute
|
|
{
|
|
public AspMvcActionAttribute() { }
|
|
public AspMvcActionAttribute(string anonymousProperty)
|
|
{
|
|
AnonymousProperty = anonymousProperty;
|
|
}
|
|
|
|
public string AnonymousProperty { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. Indicates that a parameter is an MVC area.
|
|
/// Use this attribute for custom wrappers similar to
|
|
/// <c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcAreaAttribute : PathReferenceAttribute
|
|
{
|
|
public AspMvcAreaAttribute() { }
|
|
public AspMvcAreaAttribute(string anonymousProperty)
|
|
{
|
|
AnonymousProperty = anonymousProperty;
|
|
}
|
|
|
|
public string AnonymousProperty { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is
|
|
/// an MVC controller. If applied to a method, the MVC controller name is calculated
|
|
/// implicitly from the context. Use this attribute for custom wrappers similar to
|
|
/// <c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcControllerAttribute : Attribute
|
|
{
|
|
public AspMvcControllerAttribute() { }
|
|
public AspMvcControllerAttribute(string anonymousProperty)
|
|
{
|
|
AnonymousProperty = anonymousProperty;
|
|
}
|
|
|
|
public string AnonymousProperty { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute
|
|
/// for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, String)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcMasterAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute
|
|
/// for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, Object)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcModelTypeAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC
|
|
/// partial view. If applied to a method, the MVC partial view name is calculated implicitly
|
|
/// from the context. Use this attribute for custom wrappers similar to
|
|
/// <c>System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcPartialViewAttribute : PathReferenceAttribute { }
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcSupressViewErrorAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. Indicates that a parameter is an MVC display template.
|
|
/// Use this attribute for custom wrappers similar to
|
|
/// <c>System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcDisplayTemplateAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template.
|
|
/// Use this attribute for custom wrappers similar to
|
|
/// <c>System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcEditorTemplateAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. Indicates that a parameter is an MVC template.
|
|
/// Use this attribute for custom wrappers similar to
|
|
/// <c>System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcTemplateAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter
|
|
/// is an MVC view. If applied to a method, the MVC view name is calculated implicitly
|
|
/// from the context. Use this attribute for custom wrappers similar to
|
|
/// <c>System.Web.Mvc.Controller.View(Object)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcViewAttribute : PathReferenceAttribute { }
|
|
|
|
/// <summary>
|
|
/// ASP.NET MVC attribute. When applied to a parameter of an attribute,
|
|
/// indicates that this parameter is an MVC action name
|
|
/// </summary>
|
|
/// <example><code>
|
|
/// [ActionName("Foo")]
|
|
/// public ActionResult Login(string returnUrl) {
|
|
/// ViewBag.ReturnUrl = Url.Action("Foo"); // OK
|
|
/// return RedirectToAction("Bar"); // Error: Cannot resolve action
|
|
/// }
|
|
/// </code></example>
|
|
[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMvcActionSelectorAttribute : Attribute { }
|
|
|
|
[AttributeUsage(
|
|
AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.Field)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class HtmlElementAttributesAttribute : Attribute
|
|
{
|
|
public HtmlElementAttributesAttribute() { }
|
|
public HtmlElementAttributesAttribute(string name)
|
|
{
|
|
Name = name;
|
|
}
|
|
|
|
public string Name { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(
|
|
AttributeTargets.Parameter | AttributeTargets.Field | AttributeTargets.Property)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class HtmlAttributeValueAttribute : Attribute
|
|
{
|
|
public HtmlAttributeValueAttribute([NotNull] string name)
|
|
{
|
|
Name = name;
|
|
}
|
|
|
|
[NotNull]
|
|
public string Name { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Razor attribute. Indicates that a parameter or a method is a Razor section.
|
|
/// Use this attribute for custom wrappers similar to
|
|
/// <c>System.Web.WebPages.WebPageBase.RenderSection(String)</c>
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class RazorSectionAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates how method invocation affects content of the collection
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class CollectionAccessAttribute : Attribute
|
|
{
|
|
public CollectionAccessAttribute(CollectionAccessType collectionAccessType)
|
|
{
|
|
CollectionAccessType = collectionAccessType;
|
|
}
|
|
|
|
public CollectionAccessType CollectionAccessType { get; private set; }
|
|
}
|
|
|
|
[Flags]
|
|
public enum CollectionAccessType
|
|
{
|
|
/// <summary>Method does not use or modify content of the collection</summary>
|
|
None = 0,
|
|
/// <summary>Method only reads content of the collection but does not modify it</summary>
|
|
Read = 1,
|
|
/// <summary>Method can change content of the collection but does not add new elements</summary>
|
|
ModifyExistingContent = 2,
|
|
/// <summary>Method can add new elements to the collection</summary>
|
|
UpdatedContent = ModifyExistingContent | 4
|
|
}
|
|
|
|
/// <summary>
|
|
/// Indicates that the marked method is assertion method, i.e. it halts control flow if
|
|
/// one of the conditions is satisfied. To set the condition, mark one of the parameters with
|
|
/// <see cref="AssertionConditionAttribute"/> attribute
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AssertionMethodAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates the condition parameter of the assertion method. The method itself should be
|
|
/// marked by <see cref="AssertionMethodAttribute"/> attribute. The mandatory argument of
|
|
/// the attribute is the assertion type.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AssertionConditionAttribute : Attribute
|
|
{
|
|
public AssertionConditionAttribute(AssertionConditionType conditionType)
|
|
{
|
|
ConditionType = conditionType;
|
|
}
|
|
|
|
public AssertionConditionType ConditionType { get; private set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Specifies assertion type. If the assertion method argument satisfies the condition,
|
|
/// then the execution continues. Otherwise, execution is assumed to be halted
|
|
/// </summary>
|
|
public enum AssertionConditionType
|
|
{
|
|
/// <summary>Marked parameter should be evaluated to true</summary>
|
|
IS_TRUE = 0,
|
|
/// <summary>Marked parameter should be evaluated to false</summary>
|
|
IS_FALSE = 1,
|
|
/// <summary>Marked parameter should be evaluated to null value</summary>
|
|
IS_NULL = 2,
|
|
/// <summary>Marked parameter should be evaluated to not null value</summary>
|
|
IS_NOT_NULL = 3,
|
|
}
|
|
|
|
/// <summary>
|
|
/// Indicates that the marked method unconditionally terminates control flow execution.
|
|
/// For example, it could unconditionally throw exception
|
|
/// </summary>
|
|
[Obsolete("Use [ContractAnnotation('=> halt')] instead")]
|
|
[AttributeUsage(AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class TerminatesProgramAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select,
|
|
/// .Where). This annotation allows inference of [InstantHandle] annotation for parameters
|
|
/// of delegate type by analyzing LINQ method chains.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class LinqTunnelAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that IEnumerable, passed as parameter, is not enumerated.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class NoEnumerationAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Indicates that parameter is regular expression pattern.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class RegexPatternAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// XAML attribute. Indicates the type that has <c>ItemsSource</c> property and should be
|
|
/// treated as <c>ItemsControl</c>-derived type, to enable inner items <c>DataContext</c>
|
|
/// type resolve.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Class)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class XamlItemsControlAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// XAML attibute. Indicates the property of some <c>BindingBase</c>-derived type, that
|
|
/// is used to bind some item of <c>ItemsControl</c>-derived type. This annotation will
|
|
/// enable the <c>DataContext</c> type resolve for XAML bindings for such properties.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Property should have the tree ancestor of the <c>ItemsControl</c> type or
|
|
/// marked with the <see cref="XamlItemsControlAttribute"/> attribute.
|
|
/// </remarks>
|
|
[AttributeUsage(AttributeTargets.Property)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class XamlItemBindingOfItemsControlAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspChildControlTypeAttribute : Attribute
|
|
{
|
|
public AspChildControlTypeAttribute(string tagName, Type controlType)
|
|
{
|
|
TagName = tagName;
|
|
ControlType = controlType;
|
|
}
|
|
|
|
public string TagName { get; private set; }
|
|
public Type ControlType { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspDataFieldAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspDataFieldsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Property)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspMethodPropertyAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspRequiredAttributeAttribute : Attribute
|
|
{
|
|
public AspRequiredAttributeAttribute([NotNull] string attribute)
|
|
{
|
|
Attribute = attribute;
|
|
}
|
|
|
|
public string Attribute { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Property)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class AspTypePropertyAttribute : Attribute
|
|
{
|
|
public bool CreateConstructorReferences { get; private set; }
|
|
|
|
public AspTypePropertyAttribute(bool createConstructorReferences)
|
|
{
|
|
CreateConstructorReferences = createConstructorReferences;
|
|
}
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class RazorImportNamespaceAttribute : Attribute
|
|
{
|
|
public RazorImportNamespaceAttribute(string name)
|
|
{
|
|
Name = name;
|
|
}
|
|
|
|
public string Name { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class RazorInjectionAttribute : Attribute
|
|
{
|
|
public RazorInjectionAttribute(string type, string fieldName)
|
|
{
|
|
Type = type;
|
|
FieldName = fieldName;
|
|
}
|
|
|
|
public string Type { get; private set; }
|
|
public string FieldName { get; private set; }
|
|
}
|
|
|
|
[AttributeUsage(AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class RazorHelperCommonAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Property)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class RazorLayoutAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class RazorWriteLiteralMethodAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Method)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class RazorWriteMethodAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Parameter)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class RazorWriteMethodParameterAttribute : Attribute { }
|
|
|
|
/// <summary>
|
|
/// Prevents the Member Reordering feature from tossing members of the marked class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The attribute must be mentioned in your member reordering patterns.
|
|
/// </remarks>
|
|
[AttributeUsage(AttributeTargets.All)]
|
|
[Conditional("JETBRAINS_ANNOTATIONS")]
|
|
public sealed class NoReorder : Attribute { }
|
|
}
|
|
|
|
#endif
|