AnalyzerHelper.cs 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  1. using System.Collections.Generic;
  2. using System.Linq;
  3. using Microsoft.CodeAnalysis;
  4. using Microsoft.CodeAnalysis.CSharp.Syntax;
  5. namespace ET.Analyzer
  6. {
  7. public static class AnalyzerHelper
  8. {
  9. /// <summary>
  10. /// 获取语法树节点的子节点中第一个指定类型节点
  11. /// </summary>
  12. /// <param name="syntaxNode">语法树节点</param>
  13. /// <typeparam name="T">指定语法节点类型</typeparam>
  14. /// <returns>第一个指定类型节点</returns>
  15. public static T? GetFirstChild<T>(this SyntaxNode syntaxNode) where T : SyntaxNode
  16. {
  17. foreach (SyntaxNode? childNode in syntaxNode.ChildNodes())
  18. {
  19. if (childNode.GetType() == typeof (T))
  20. {
  21. return childNode as T;
  22. }
  23. }
  24. return null;
  25. }
  26. public static SyntaxNode? GetFirstChild(this SyntaxNode syntaxNode)
  27. {
  28. var childNodes = syntaxNode.ChildNodes();
  29. if (childNodes.Count() > 0)
  30. {
  31. return childNodes.First();
  32. }
  33. return null;
  34. }
  35. /// <summary>
  36. /// 获取语法树节点的子节点中最后一个指定类型节点
  37. /// </summary>
  38. /// <param name="syntaxNode">语法树节点</param>
  39. /// <typeparam name="T">指定语法节点类型</typeparam>
  40. /// <returns>最后一个指定类型节点</returns>
  41. public static T? GetLastChild<T>(this SyntaxNode syntaxNode) where T : SyntaxNode
  42. {
  43. foreach (SyntaxNode? childNode in syntaxNode.ChildNodes().Reverse())
  44. {
  45. if (childNode.GetType() == typeof (T))
  46. {
  47. return childNode as T;
  48. }
  49. }
  50. return null;
  51. }
  52. /// <summary>
  53. /// 获取语法节点所属的ClassDeclarationSyntax
  54. /// </summary>
  55. public static ClassDeclarationSyntax? GetParentClassDeclaration(this SyntaxNode syntaxNode)
  56. {
  57. SyntaxNode? parentNode = syntaxNode.Parent;
  58. while (parentNode != null)
  59. {
  60. if (parentNode is ClassDeclarationSyntax classDeclarationSyntax)
  61. {
  62. return classDeclarationSyntax;
  63. }
  64. parentNode = parentNode.Parent;
  65. }
  66. return null;
  67. }
  68. /// <summary>
  69. /// INamedTypeSymbol 是否有指定的Attribute
  70. /// </summary>
  71. public static bool HasAttribute(this INamedTypeSymbol namedTypeSymbol, string AttributeName)
  72. {
  73. foreach (AttributeData? attributeData in namedTypeSymbol.GetAttributes())
  74. {
  75. if (attributeData.AttributeClass?.ToString() == AttributeName)
  76. {
  77. return true;
  78. }
  79. }
  80. return false;
  81. }
  82. /// <summary>
  83. /// INamedTypeSymbol 是否有指定的基类Attribute
  84. /// </summary>
  85. public static bool HasBaseAttribute(this INamedTypeSymbol namedTypeSymbol, string AttributeName)
  86. {
  87. foreach (AttributeData? attributeData in namedTypeSymbol.GetAttributes())
  88. {
  89. INamedTypeSymbol? attributeType = attributeData.AttributeClass?.BaseType;
  90. while (attributeType != null)
  91. {
  92. if (attributeType.ToString() == AttributeName)
  93. {
  94. return true;
  95. }
  96. attributeType = attributeType.BaseType;
  97. }
  98. }
  99. return false;
  100. }
  101. /// <summary>
  102. /// INamedTypeSymbol 获取指定类型的第一个Attribute
  103. /// </summary>
  104. public static AttributeData? GetFirstAttribute(this INamedTypeSymbol namedTypeSymbol, string AttributeName)
  105. {
  106. foreach (AttributeData? attributeData in namedTypeSymbol.GetAttributes())
  107. {
  108. if (attributeData.AttributeClass?.ToString() == AttributeName)
  109. {
  110. return attributeData;
  111. }
  112. }
  113. return null;
  114. }
  115. /// <summary>
  116. /// INamedTypeSymbol 是否含有指定接口
  117. /// </summary>
  118. public static bool HasInterface(this INamedTypeSymbol namedTypeSymbol, string InterfaceName)
  119. {
  120. foreach (INamedTypeSymbol? iInterface in namedTypeSymbol.AllInterfaces)
  121. {
  122. if (iInterface.ToString() == InterfaceName)
  123. {
  124. return true;
  125. }
  126. }
  127. return false;
  128. }
  129. /// <summary>
  130. /// 判断指定的程序集是否需要分析
  131. /// </summary>
  132. public static bool IsAssemblyNeedAnalyze(string? assemblyName, params string[] analyzeAssemblyNames)
  133. {
  134. if (assemblyName == null)
  135. {
  136. return false;
  137. }
  138. foreach (string analyzeAssemblyName in analyzeAssemblyNames)
  139. {
  140. if (assemblyName == analyzeAssemblyName)
  141. {
  142. return true;
  143. }
  144. }
  145. return false;
  146. }
  147. /// <summary>
  148. /// 获取 成员访问语法节点的父级类型
  149. /// </summary>
  150. public static ITypeSymbol? GetMemberAccessSyntaxParentType(this MemberAccessExpressionSyntax memberAccessExpressionSyntax,
  151. SemanticModel semanticModel)
  152. {
  153. SyntaxNode? firstChildSyntaxNode = memberAccessExpressionSyntax.GetFirstChild();
  154. if (firstChildSyntaxNode == null)
  155. {
  156. return null;
  157. }
  158. ISymbol? firstChildSymbol = semanticModel.GetSymbolInfo(firstChildSyntaxNode).Symbol;
  159. if (firstChildSymbol == null)
  160. {
  161. return null;
  162. }
  163. if (firstChildSymbol is ILocalSymbol localSymbol)
  164. {
  165. return localSymbol.Type;
  166. }
  167. if (firstChildSymbol is IParameterSymbol parameterSymbol)
  168. {
  169. return parameterSymbol.Type;
  170. }
  171. if (firstChildSymbol is IPropertySymbol propertySymbol)
  172. {
  173. return propertySymbol.Type;
  174. }
  175. if (firstChildSymbol is IMethodSymbol methodSymbol)
  176. {
  177. return methodSymbol.ReturnType;
  178. }
  179. if (firstChildSymbol is IFieldSymbol fieldSymbol)
  180. {
  181. return fieldSymbol.Type;
  182. }
  183. if (firstChildSymbol is IEventSymbol eventSymbol)
  184. {
  185. return eventSymbol.Type;
  186. }
  187. return null;
  188. }
  189. /// <summary>
  190. /// 获取最近的指定类型祖先节点
  191. /// </summary>
  192. public static T? GetNeareastAncestor<T>(this SyntaxNode syntaxNode) where T:SyntaxNode
  193. {
  194. foreach (var ancestorNode in syntaxNode.Ancestors())
  195. {
  196. if (ancestorNode is T Tancestor)
  197. {
  198. return Tancestor;
  199. }
  200. }
  201. return null ;
  202. }
  203. /// <summary>
  204. /// 判断函数是否是否含有指定类型的参数
  205. /// </summary>
  206. public static bool HasParameterType(this IMethodSymbol methodSymbol, string parameterType, out IParameterSymbol? cencelTokenSymbol)
  207. {
  208. foreach (var parameterSymbol in methodSymbol.Parameters)
  209. {
  210. if (parameterSymbol.Type.ToString() == parameterType)
  211. {
  212. cencelTokenSymbol = parameterSymbol;
  213. return true;
  214. }
  215. }
  216. cencelTokenSymbol = null;
  217. return false;
  218. }
  219. /// <summary>
  220. /// 获取所有指定类型的子节点
  221. /// </summary>
  222. public static IEnumerable<T> DescendantNodes<T>(this SyntaxNode syntaxNode) where T : SyntaxNode
  223. {
  224. foreach (var descendantNode in syntaxNode.DescendantNodes())
  225. {
  226. if (descendantNode is T node)
  227. {
  228. yield return node;
  229. }
  230. }
  231. }
  232. /// <summary>
  233. /// 获取与该语法节点同层级的上一个节点
  234. /// </summary>
  235. public static SyntaxNode? PreviousNode(this SyntaxNode syntaxNode)
  236. {
  237. if (syntaxNode.Parent==null)
  238. {
  239. return null;
  240. }
  241. int index = 0;
  242. foreach (var childNode in syntaxNode.Parent.ChildNodes())
  243. {
  244. if (childNode == syntaxNode)
  245. {
  246. break;
  247. }
  248. index++;
  249. }
  250. if (index==0)
  251. {
  252. return null;
  253. }
  254. return syntaxNode.Parent.ChildNodes().ElementAt(index-1);
  255. }
  256. /// <summary>
  257. /// 获取与该语法节点同层级的下一个节点
  258. /// </summary>
  259. public static SyntaxNode? NextNode(this SyntaxNode syntaxNode)
  260. {
  261. if (syntaxNode.Parent==null)
  262. {
  263. return null;
  264. }
  265. int index = 0;
  266. foreach (var childNode in syntaxNode.Parent.ChildNodes())
  267. {
  268. if (childNode == syntaxNode)
  269. {
  270. break;
  271. }
  272. index++;
  273. }
  274. if (index == syntaxNode.Parent.ChildNodes().Count()-1)
  275. {
  276. return null;
  277. }
  278. return syntaxNode.Parent.ChildNodes().ElementAt(index+1);
  279. }
  280. }
  281. }