|
| 1 | +using Rubberduck.Parsing.Grammar; |
| 2 | +using Rubberduck.Parsing.Symbols; |
| 3 | +using Rubberduck.Resources; |
| 4 | +using System; |
| 5 | +using System.Collections.Generic; |
| 6 | +using System.Globalization; |
| 7 | +using System.Linq; |
| 8 | +using System.Text; |
| 9 | +using System.Threading.Tasks; |
| 10 | + |
| 11 | +namespace Rubberduck.Refactorings.Common |
| 12 | +{ |
| 13 | + public static class VBAIdentifierValidator |
| 14 | + { |
| 15 | + private static IEnumerable<string> ReservedIdentifiers = |
| 16 | + typeof(Tokens).GetFields().Select(item => item.GetValue(null).ToString()).ToArray(); |
| 17 | + |
| 18 | + /// <summary> |
| 19 | + /// Predicate function determining if an identifier string's content will trigger a result for the UseMeaningfulNames inspection. |
| 20 | + /// </summary> |
| 21 | + public static bool IsMeaningfulIdentifier(string name) |
| 22 | + => !TryMatchMeaninglessIdentifierCriteria(name, out _); |
| 23 | + |
| 24 | + /// <summary> |
| 25 | + /// Evaluates if an identifier string's content will trigger a result for the UseMeaningfulNames inspection. |
| 26 | + /// </summary> |
| 27 | + /// <returns>Message indicating that the string will result in a UseMeaningfulNames inspection result</returns> |
| 28 | + public static bool TryMatchMeaninglessIdentifierCriteria(string name, out string criteriaMatchMessage) |
| 29 | + { |
| 30 | + criteriaMatchMessage = string.Empty; |
| 31 | + string Vowels = "aeiouyàâäéèêëïîöôùûü"; |
| 32 | + int MinimumNameLength = 3; |
| 33 | + |
| 34 | + bool HasVowel() |
| 35 | + => name.Any(character => Vowels.Any(vowel => |
| 36 | + string.Compare(vowel.ToString(CultureInfo.InvariantCulture), |
| 37 | + character.ToString(CultureInfo.InvariantCulture), StringComparison.OrdinalIgnoreCase) == 0)); |
| 38 | + |
| 39 | + bool HasConsonant() |
| 40 | + => !name.All(character => Vowels.Any(vowel => |
| 41 | + string.Compare(vowel.ToString(CultureInfo.InvariantCulture), |
| 42 | + character.ToString(CultureInfo.InvariantCulture), StringComparison.OrdinalIgnoreCase) == 0)); |
| 43 | + |
| 44 | + bool IsRepeatedCharacter() |
| 45 | + { |
| 46 | + var firstLetter = name.First().ToString(CultureInfo.InvariantCulture); |
| 47 | + return name.All(a => string.Compare(a.ToString(CultureInfo.InvariantCulture), firstLetter, |
| 48 | + StringComparison.OrdinalIgnoreCase) == 0); |
| 49 | + } |
| 50 | + |
| 51 | + bool EndsWithDigit() |
| 52 | + => char.IsDigit(name.Last()); |
| 53 | + |
| 54 | + bool IsTooShort() |
| 55 | + => name.Length < MinimumNameLength; |
| 56 | + |
| 57 | + var isMeaningless = !(HasVowel() |
| 58 | + && HasConsonant() |
| 59 | + && !IsRepeatedCharacter() |
| 60 | + && !IsTooShort() |
| 61 | + && !EndsWithDigit()); |
| 62 | + |
| 63 | + if (isMeaningless) |
| 64 | + { |
| 65 | + criteriaMatchMessage = string.Format(RubberduckUI.MeaninglessNameCriteriaMatchFormat, name); |
| 66 | + } |
| 67 | + return isMeaningless; |
| 68 | + } |
| 69 | + |
| 70 | + /// <summary> |
| 71 | + /// Predicate function determining if an identifier string conforms to MS-VBAL naming requirements |
| 72 | + /// </summary> |
| 73 | + public static bool IsValidIdentifier(string name, DeclarationType declarationType) |
| 74 | + => !TryMatchInvalidIdentifierCriteria(name, declarationType, out _); |
| 75 | + |
| 76 | + /// <summary> |
| 77 | + /// Evaluates an identifier string's conformance with MS-VBAL naming requirements. |
| 78 | + /// </summary> |
| 79 | + /// <returns>Message for first matching invalid identifier criteria. Or, an empty string if the identifier is valid</returns> |
| 80 | + public static bool TryMatchInvalidIdentifierCriteria(string name, DeclarationType declarationType, out string criteriaMatchMessage) |
| 81 | + { |
| 82 | + criteriaMatchMessage = string.Empty; |
| 83 | + |
| 84 | + var maxNameLength = declarationType.HasFlag(DeclarationType.Module) |
| 85 | + ? Declaration.MaxModuleNameLength : Declaration.MaxMemberNameLength; |
| 86 | + |
| 87 | + if (string.IsNullOrEmpty(name)) |
| 88 | + { |
| 89 | + criteriaMatchMessage = RubberduckUI.InvalidNameCriteria_IsNullOrEmpty; |
| 90 | + return true; |
| 91 | + } |
| 92 | + |
| 93 | + //Does not start with a letter |
| 94 | + if (!char.IsLetter(name.First())) |
| 95 | + { |
| 96 | + criteriaMatchMessage = string.Format(RubberduckUI.InvalidNameCriteria_DoesNotStartWithLetterFormat, name); |
| 97 | + return true; |
| 98 | + } |
| 99 | + |
| 100 | + //Has special characters |
| 101 | + if (name.Any(c => !char.IsLetterOrDigit(c) && c != '_')) |
| 102 | + { |
| 103 | + criteriaMatchMessage = string.Format(RubberduckUI.InvalidNameCriteria_InvalidCharactersFormat, name); |
| 104 | + return true; |
| 105 | + } |
| 106 | + |
| 107 | + //Is a reserved identifier |
| 108 | + if (ReservedIdentifiers.Contains(name, StringComparer.InvariantCultureIgnoreCase)) |
| 109 | + { |
| 110 | + criteriaMatchMessage = string.Format(RubberduckUI.InvalidNameCriteria_IsReservedKeywordFormat, name); |
| 111 | + return true; |
| 112 | + } |
| 113 | + |
| 114 | + //"VBA" identifier not allowed for projects |
| 115 | + if (declarationType.HasFlag(DeclarationType.Project) |
| 116 | + && name.Equals("VBA", StringComparison.InvariantCultureIgnoreCase)) |
| 117 | + { |
| 118 | + criteriaMatchMessage = string.Format(RubberduckUI.InvalidNameCriteria_IsReservedKeywordFormat, name); |
| 119 | + return true; |
| 120 | + } |
| 121 | + |
| 122 | + //Exceeds max length |
| 123 | + if (name.Length > maxNameLength) |
| 124 | + { |
| 125 | + criteriaMatchMessage = string.Format(RubberduckUI.InvalidNameCriteria_ExceedsMaximumLengthFormat, name); |
| 126 | + return true; |
| 127 | + } |
| 128 | + return false; |
| 129 | + } |
| 130 | + } |
| 131 | +} |
0 commit comments