/* * Copyright 2007-2012 JetBrains s.r.o. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // Not yet used in PDFsharp. #pragma warning disable 1591 // Currently not used. #if true_ using System; using System.ComponentModel; namespace JetBrains.Annotations { /// /// Indicates that marked element should be localized or not. /// /// /// /// [LocalizationRequiredAttribute(true)] /// public class Foo /// { /// private string str = "my string"; // Warning: Localizable string /// } /// /// [AttributeUsage(AttributeTargets.All, AllowMultiple = false, Inherited = true)] public sealed class LocalizationRequiredAttribute : Attribute { /// /// Initializes a new instance of the class with /// set to . /// public LocalizationRequiredAttribute() : this(true) { } /// /// Initializes a new instance of the class. /// /// true if a element should be localized; otherwise, false. public LocalizationRequiredAttribute(bool required) { Required = required; } /// /// Gets a value indicating whether a element should be localized. /// true if a element should be localized; otherwise, false. /// [UsedImplicitly] public bool Required { get; private set; } /// /// Returns whether the value of the given object is equal to the current . /// /// The object to test the value equality of. /// /// true if the value of the given object is equal to that of the current; otherwise, false. /// public override bool Equals(object obj) { var attribute = obj as LocalizationRequiredAttribute; return attribute != null && attribute.Required == Required; } /// /// Returns the hash code for this instance. /// /// A hash code for the current . public override int GetHashCode() { return base.GetHashCode(); } } /// /// 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 -like form /// /// /// /// [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 /// } /// /// [AttributeUsage(AttributeTargets.Constructor | AttributeTargets.Method, AllowMultiple = false, Inherited = true)] public sealed class StringFormatMethodAttribute : Attribute { /// /// Initializes new instance of StringFormatMethodAttribute /// /// Specifies which parameter of an annotated method should be treated as format-string public StringFormatMethodAttribute(string formatParameterName) { FormatParameterName = formatParameterName; } /// /// Gets format parameter name /// [UsedImplicitly] public string FormatParameterName { get; private set; } } /// /// 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 . /// /// /// /// public void Foo(string param) /// { /// if (param == null) /// throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol /// } /// /// [AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false, Inherited = true)] public sealed class InvokerParameterNameAttribute : Attribute { } /// /// Indicates that the method is contained in a type that implements /// interface /// and this method is used to notify that some property value changed. /// /// /// The method should be non-static and conform to one of the supported signatures: /// /// NotifyChanged(string) /// NotifyChanged(params string[]) /// NotifyChanged{T}(Expression{Func{T}}) /// NotifyChanged{T,U}(Expression{Func{T,U}}) /// SetProperty{T}(ref T, T, string) /// /// /// /// /// 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 /// } /// } /// } /// /// Examples of generated notifications: /// /// NotifyChanged("Property") /// NotifyChanged(() => Property) /// NotifyChanged((VM x) => x.Property) /// SetProperty(ref myField, value, "Property") /// /// [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)] public sealed class NotifyPropertyChangedInvocatorAttribute : Attribute { public NotifyPropertyChangedInvocatorAttribute() { } public NotifyPropertyChangedInvocatorAttribute(string parameterName) { ParameterName = parameterName; } [UsedImplicitly] public string ParameterName { get; private set; } } /// /// Indicates that the value of the marked element could be null sometimes, /// so the check for null is necessary before its usage. /// /// /// /// [CanBeNull] /// public object Test() /// { /// return null; /// } /// /// public void UseTest() /// { /// var p = Test(); /// var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' /// } /// /// [AttributeUsage(AttributeTargets.Method | AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.Delegate | AttributeTargets.Field, AllowMultiple = false, Inherited = true)] public sealed class CanBeNullAttribute : Attribute { } /// /// Indicates that the value of the marked element could never be null /// /// /// /// [NotNull] /// public object Foo() /// { /// return null; // Warning: Possible 'null' assignment /// } /// /// [AttributeUsage(AttributeTargets.Method | AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.Delegate | AttributeTargets.Field, AllowMultiple = false, Inherited = true)] public sealed class NotNullAttribute : Attribute { } /// /// Describes dependency between method input and output. /// /// ///

Function Definition Table syntax:

/// /// FDT ::= FDTRow [;FDTRow]* /// FDTRow ::= Input => Output | Output <= Input /// Input ::= ParameterName: Value [, Input]* /// Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} /// Value ::= true | false | null | notnull | canbenull /// /// If method has single input parameter, its name could be omitted.
/// Using halt (or void/nothing, which is the same) for method output means that the methos doesn't return normally.
/// canbenull annotation is only applicable for output parameters.
/// You can use multiple [ContractAnnotation] for each FDT row, or use single attribute with rows separated by semicolon.
///
/// /// /// /// [ContractAnnotation("=> halt")] /// public void TerminationMethod() /// /// /// [ContractAnnotation("halt <= condition: false")] /// public void Assert(bool condition, string text) // Regular Assertion method /// /// /// [ContractAnnotation("s:null => true")] /// public bool IsNullOrEmpty(string s) // String.IsNullOrEmpty /// /// /// // 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) /// /// /// [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] /// public bool TryParse(string s, out Person result) /// /// /// [AttributeUsage(AttributeTargets.Method, AllowMultiple = true, Inherited = true)] public sealed class ContractAnnotationAttribute : Attribute { public ContractAnnotationAttribute([NotNull] string fdt) : this(fdt, false) { } public ContractAnnotationAttribute([NotNull] string fdt, bool forceFullStates) { FDT = fdt; ForceFullStates = forceFullStates; } public string FDT { get; private set; } public bool ForceFullStates { get; private set; } } /// /// Indicates that the value of the marked type (or its derivatives) /// cannot be compared using '==' or '!=' operators and Equals() should be used instead. /// However, using '==' or '!=' for comparison with null is always permitted. /// /// /// /// [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 /// } /// } /// } /// /// [AttributeUsage(AttributeTargets.Interface | AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = false, Inherited = true)] public sealed class CannotApplyEqualityOperatorAttribute : Attribute { } /// /// 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. /// /// /// /// [BaseTypeRequired(typeof(IComponent)] // Specify requirement /// public class ComponentAttribute : Attribute /// {} /// /// [Component] // ComponentAttribute requires implementing IComponent interface /// public class MyComponent : IComponent /// {} /// /// [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)] [BaseTypeRequired(typeof(Attribute))] public sealed class BaseTypeRequiredAttribute : Attribute { /// /// Initializes new instance of BaseTypeRequiredAttribute /// /// Specifies which types are required public BaseTypeRequiredAttribute(Type baseType) { BaseTypes = new[] { baseType }; } /// /// Gets enumerations of specified base types /// public Type[] BaseTypes { get; private set; } } /// /// 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) /// [AttributeUsage(AttributeTargets.All, AllowMultiple = false, Inherited = true)] public sealed class UsedImplicitlyAttribute : Attribute { [UsedImplicitly] public UsedImplicitlyAttribute() : this(ImplicitUseKindFlags.Default, ImplicitUseTargetFlags.Default) { } [UsedImplicitly] public UsedImplicitlyAttribute(ImplicitUseKindFlags useKindFlags, ImplicitUseTargetFlags targetFlags) { UseKindFlags = useKindFlags; TargetFlags = targetFlags; } [UsedImplicitly] public UsedImplicitlyAttribute(ImplicitUseKindFlags useKindFlags) : this(useKindFlags, ImplicitUseTargetFlags.Default) { } [UsedImplicitly] public UsedImplicitlyAttribute(ImplicitUseTargetFlags targetFlags) : this(ImplicitUseKindFlags.Default, targetFlags) { } [UsedImplicitly] public ImplicitUseKindFlags UseKindFlags { get; private set; } /// /// Gets value indicating what is meant to be used /// [UsedImplicitly] public ImplicitUseTargetFlags TargetFlags { get; private set; } } /// /// 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) /// [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)] public sealed class MeansImplicitUseAttribute : Attribute { [UsedImplicitly] public MeansImplicitUseAttribute() : this(ImplicitUseKindFlags.Default, ImplicitUseTargetFlags.Default) { } [UsedImplicitly] public MeansImplicitUseAttribute(ImplicitUseKindFlags useKindFlags, ImplicitUseTargetFlags targetFlags) { UseKindFlags = useKindFlags; TargetFlags = targetFlags; } [UsedImplicitly] public MeansImplicitUseAttribute(ImplicitUseKindFlags useKindFlags) : this(useKindFlags, ImplicitUseTargetFlags.Default) { } [UsedImplicitly] public MeansImplicitUseAttribute(ImplicitUseTargetFlags targetFlags) : this(ImplicitUseKindFlags.Default, targetFlags) { } [UsedImplicitly] public ImplicitUseKindFlags UseKindFlags { get; private set; } /// /// Gets value indicating what is meant to be used /// [UsedImplicitly] public ImplicitUseTargetFlags TargetFlags { get; private set; } } [Flags] public enum ImplicitUseKindFlags { Default = Access | Assign | InstantiatedWithFixedConstructorSignature, /// /// Only entity marked with attribute considered used /// Access = 1, /// /// Indicates implicit assignment to a member /// Assign = 2, /// /// Indicates implicit instantiation of a type with fixed constructor signature. /// That means any unused constructor parameters won't be reported as such. /// InstantiatedWithFixedConstructorSignature = 4, /// /// Indicates implicit instantiation of a type /// InstantiatedNoFixedConstructorSignature = 8, } /// /// Specify what is considered used implicitly when marked with or /// [Flags] public enum ImplicitUseTargetFlags { Default = Itself, Itself = 1, /// /// Members of entity marked with attribute are considered used /// Members = 2, /// /// Entity marked with attribute and all its members considered used /// WithMembers = Itself | Members } /// /// This attribute is intended to mark publicly available API which should not be removed and so is treated as used. /// [MeansImplicitUse] public sealed class PublicAPIAttribute : Attribute { public PublicAPIAttribute() { } public PublicAPIAttribute(string comment) { } } /// /// 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. /// [AttributeUsage(AttributeTargets.Parameter, Inherited = true)] public sealed class InstantHandleAttribute : Attribute { } /// /// Indicates that a method does not make any observable state changes. /// The same as /// /// /// /// [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 /// } /// /// [AttributeUsage(AttributeTargets.Method, Inherited = true)] public sealed class PureAttribute : Attribute { } /// /// 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 (~). /// [AttributeUsage(AttributeTargets.Parameter)] public class PathReferenceAttribute : Attribute { public PathReferenceAttribute() { } [UsedImplicitly] public PathReferenceAttribute([PathReference] string basePath) { BasePath = basePath; } [UsedImplicitly] public string BasePath { get; private set; } } // ASP.NET MVC attributes /// /// 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 /// /// [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method)] public sealed class AspMvcActionAttribute : Attribute { [UsedImplicitly] public string AnonymousProperty { get; private set; } public AspMvcActionAttribute() { } public AspMvcActionAttribute(string anonymousProperty) { AnonymousProperty = anonymousProperty; } } /// /// ASP.NET MVC attribute. Indicates that a parameter is an MVC araa. /// Use this attribute for custom wrappers similar to /// /// [AttributeUsage(AttributeTargets.Parameter)] public sealed class AspMvcAreaAttribute : PathReferenceAttribute { [UsedImplicitly] public string AnonymousProperty { get; private set; } [UsedImplicitly] public AspMvcAreaAttribute() { } public AspMvcAreaAttribute(string anonymousProperty) { AnonymousProperty = anonymousProperty; } } /// /// 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 /// /// [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method)] public sealed class AspMvcControllerAttribute : Attribute { [UsedImplicitly] public string AnonymousProperty { get; private set; } public AspMvcControllerAttribute() { } public AspMvcControllerAttribute(string anonymousProperty) { AnonymousProperty = anonymousProperty; } } /// /// ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. /// Use this attribute for custom wrappers similar to /// /// [AttributeUsage(AttributeTargets.Parameter)] public sealed class AspMvcMasterAttribute : Attribute { } /// /// ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. /// Use this attribute for custom wrappers similar to /// /// [AttributeUsage(AttributeTargets.Parameter)] public sealed class AspMvcModelTypeAttribute : Attribute { } /// /// 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 /// /// [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method)] public sealed class AspMvcPartialViewAttribute : PathReferenceAttribute { } /// /// ASP.NET MVC attribute. Allows disabling all inspections for MVC views within a class or a method. /// [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)] public sealed class AspMvcSupressViewErrorAttribute : Attribute { } /// /// ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. /// Use this attribute for custom wrappers similar to /// /// [AttributeUsage(AttributeTargets.Parameter)] public sealed class AspMvcDisplayTemplateAttribute : Attribute { } /// /// ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. /// Use this attribute for custom wrappers similar to /// /// [AttributeUsage(AttributeTargets.Parameter)] public sealed class AspMvcEditorTemplateAttribute : Attribute { } /// /// 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 /// /// [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method)] public sealed class AspMvcViewAttribute : PathReferenceAttribute { } /// /// ASP.NET MVC attribute. When applied to a parameter of an attribute, /// indicates that this parameter is an MVC action name. /// /// /// /// [ActionName("Foo")] /// public ActionResult Login(string returnUrl) /// { /// ViewBag.ReturnUrl = Url.Action("Foo"); // OK /// return RedirectToAction("Bar"); // Error: Cannot resolve action /// } /// /// [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property)] public sealed class AspMvcActionSelectorAttribute : Attribute { } // Razor attributes /// /// Razor attribute. Indicates that a parameter or a method is a Razor section. /// Use this attribute for custom wrappers similar to /// /// [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Method, Inherited = true)] public sealed class RazorSectionAttribute : Attribute { } } #endif