public static bool IsAvailable([CanBeNull] IPropertyDeclaration propertyDeclaration)
{
if (propertyDeclaration == null)
{
return(false);
}
if (!propertyDeclaration.IsFromUnityProject())
{
return(false);
}
if (AutomaticToBackingFieldAction.IsAvailable(propertyDeclaration))
{
var unityApi = propertyDeclaration.GetSolution().GetComponent <UnityApi>();
var containingType = propertyDeclaration.DeclaredElement?.GetContainingType();
return(containingType != null && unityApi.IsUnityType(containingType));
}
return(false);
}
/// <summary>
/// Inserts a value element to the element if its missing.
/// </summary>
/// <param name="propertyDeclaration">
/// The <see cref="IPropertyDeclaration"/> to check and fix.
/// </param>
public void InsertValueElement(IPropertyDeclaration propertyDeclaration)
{
DeclarationHeader declarationHeader = new DeclarationHeader(propertyDeclaration);
if (declarationHeader.IsMissing || declarationHeader.IsInherited)
{
return;
}
XmlNode xmlNode = declarationHeader.XmlNode;
string valueText = string.Empty;
XmlNode valueXmlNode = declarationHeader.ValueXmlNode;
IContextBoundSettingsStore settingsStore = PsiSourceFileExtensions.GetSettingsStore(null, propertyDeclaration.GetSolution());
if (settingsStore.GetValue((StyleCopOptionsSettingsKey key) => key.InsertTextIntoDocumentation))
{
valueText = string.Format("The {0}.", Utils.ConvertTextToSentence(propertyDeclaration.DeclaredName).ToLower());
}
if (declarationHeader.HasValue)
{
if (string.IsNullOrEmpty(valueXmlNode.InnerText.Trim()))
{
valueXmlNode.InnerText = valueText;
declarationHeader.Update();
}
}
else
{
XmlNode valueNode = CreateNode(xmlNode, "value");
valueNode.InnerText = valueText;
xmlNode.AppendChild(valueNode);
declarationHeader.Update();
}
}
/// <summary>
/// Creates a valid value element for a property declaration.
/// </summary>
/// <param name="propertyDeclaration">
/// The property declaration.
/// </param>
/// <returns>
/// A valid value string for the property passed in.
/// </returns>
public static string CreateValueDocumentationForProperty(IPropertyDeclaration propertyDeclaration)
{
IContextBoundSettingsStore settingsStore = PsiSourceFileExtensions.GetSettingsStore(null, propertyDeclaration.GetSolution());
if (!settingsStore.GetValue((StyleCopOptionsSettingsKey key) => key.InsertTextIntoDocumentation))
{
return string.Empty;
}
return string.Format("<value>The {0}.</value>", ConvertTextToSentence(propertyDeclaration.DeclaredName).ToLower());
}
/// <summary>
/// Creates a summary for the property.
/// </summary>
/// <param name="propertyDeclaration">
/// The property declaration.
/// </param>
/// <returns>
/// A String summary of the property.
/// </returns>
public static string CreateSummaryDocumentationForProperty(IPropertyDeclaration propertyDeclaration)
{
IContextBoundSettingsStore settingsStore = PsiSourceFileExtensions.GetSettingsStore(null, propertyDeclaration.GetSolution());
if (!settingsStore.GetValue((StyleCopOptionsSettingsKey key) => key.InsertTextIntoDocumentation))
{
return string.Empty;
}
IAccessor getter = propertyDeclaration.Getter();
IAccessor setter = propertyDeclaration.Setter();
string summaryText = string.Empty;
string midText = IsPropertyBoolean(propertyDeclaration) ? "a value indicating whether " : string.Empty;
if (getter != null)
{
summaryText = "Gets {0}{1}.";
}
if (setter != null)
{
AccessRights setterAccessRight = setter.GetAccessRights();
if ((setterAccessRight == AccessRights.PRIVATE && propertyDeclaration.GetAccessRights() == AccessRights.PRIVATE)
|| setterAccessRight == AccessRights.PUBLIC || setterAccessRight == AccessRights.PROTECTED || setterAccessRight == AccessRights.PROTECTED_OR_INTERNAL
|| setterAccessRight == AccessRights.INTERNAL)
{
if (string.IsNullOrEmpty(summaryText))
{
summaryText = "Sets {0}{1}.";
}
else
{
summaryText = "Gets or sets {0}{1}.";
}
}
}
return string.Format(summaryText, midText, propertyDeclaration.DeclaredName);
}
