Handle attributes (#1)

Handling for attributes

    Note: method parameter attributes are not supported

Author: ATrefzer

.gitignore

@@ -368,3 +368,4 @@ FodyWeavers.xsd
 /Documentation/.$CSharpAnalyst.drawio.bkp
 *.dtmp
 /tmp
+/SampleProject/project.json

CSharpCodeAnalyst/GraphArea/MsaglBuilder.cs

@@ -274,6 +274,11 @@ private static string GetLabelText(Dependency dependency)
             return string.Empty;
         }
 
+        if (dependency.Type == DependencyType.UsesAttribute)
+        {
+            return string.Empty;
+        }
+
         return dependency.Type.ToString();
     }
 

CSharpCodeAnalyst/MainViewModel.cs

@@ -35,7 +35,6 @@ internal class MainViewModel : INotifyPropertyChanged
     private readonly MessageBus _messaging;
 
     private readonly ProjectExclusionRegExCollection _projectExclusionFilters;
-    private readonly int _warningCodeElementLimit;
     private CodeGraph? _codeGraph;
     private CycleSummaryViewModel? _cycleSummaryViewModel;
 
@@ -67,7 +66,6 @@ internal MainViewModel(MessageBus messaging, ApplicationSettings? settings)
         {
             _isInfoPanelVisible = settings.DefaultShowQuickHelp;
             _projectExclusionFilters.Initialize(settings.DefaultProjectExcludeFilter, ";");
-            _warningCodeElementLimit = settings.WarningCodeElementLimit;
         }
 
         _messaging = messaging;
@@ -614,7 +612,7 @@ private void LoadProject()
                 throw new NullReferenceException();
             }
 
-            var codeGraph = projectData.CreateCodeStructure();
+            var codeGraph = projectData.CreateCodeGraph();
 
 
             // Load settings
@@ -666,7 +664,7 @@ private void SaveProject()
         }
 
         var projectData = new ProjectData();
-        projectData.AddCodeStructure(_codeGraph);
+        projectData.AddCodeGraph(_codeGraph);
         projectData.Settings[nameof(IsInfoPanelVisible)] = IsInfoPanelVisible.ToString();
         projectData.Settings[nameof(GraphViewModel.ShowFlatGraph)] = _graphViewModel.ShowFlatGraph.ToString();
         projectData.Settings[nameof(ProjectExclusionRegExCollection)] = _projectExclusionFilters.ToString();
@@ -713,7 +711,7 @@ internal bool OnClosing()
     {
         if (_isSaved is false)
         {
-            if (MessageBox.Show("Do you wan't to save the project so you don't have to import it again?", "Save",
+            if (MessageBox.Show("Do you want to save the project so you don't have to import it again?", "Save",
                     MessageBoxButton.YesNo, MessageBoxImage.Question) == MessageBoxResult.Yes)
             {
                 SaveProject();

CSharpCodeAnalyst/Project/ProjectData.cs

@@ -15,10 +15,10 @@ public class ProjectData
     /// <summary>
     ///     Flatten the recursive structures.
     /// </summary>
-    public void AddCodeStructure(CodeGraph codeGraph)
+    public void AddCodeGraph(CodeGraph codeGraph)
     {
         CodeElements = codeGraph.Nodes.Values
-            .Select(n => new SerializableCodeElement(n.Id, n.Name, n.FullName, n.ElementType, n.SourceLocations)
+            .Select(n => new SerializableCodeElement(n.Id, n.Name, n.FullName, n.ElementType, n.SourceLocations, n.Attributes)
                 { SourceLocations = n.SourceLocations }).ToList();
 
         // We iterate over children, so we expect to have a parent
@@ -33,7 +33,7 @@ public void AddCodeStructure(CodeGraph codeGraph)
             .ToList();
     }
 
-    public CodeGraph CreateCodeStructure()
+    public CodeGraph CreateCodeGraph()
     {
         var codeStructure = new CodeGraph();
 
@@ -42,6 +42,7 @@ public CodeGraph CreateCodeStructure()
         {
             var element = new CodeElement(se.Id, se.ElementType, se.Name, se.FullName, null!);
             element.SourceLocations = se.SourceLocations;
+            element.Attributes = se.Attributes;
             codeStructure.Nodes.Add(element.Id, element);
         }
 

CSharpCodeAnalyst/Project/SerializableCodeElement.cs

@@ -8,11 +8,13 @@ public class SerializableCodeElement(
     string name,
     string fullName,
     CodeElementType elementType,
-    List<SourceLocation> sourceLocations)
+    List<SourceLocation> sourceLocations, 
+    HashSet<string> attributes)
 {
     public string Id { get; set; } = id;
     public string Name { get; set; } = name;
     public string FullName { get; set; } = fullName;
     public CodeElementType ElementType { get; set; } = elementType;
     public List<SourceLocation> SourceLocations { get; set; } = sourceLocations;
+    public HashSet<string> Attributes { get; set; } = attributes;
 }

CSharpCodeAnalyst/board.txt

@@ -1,13 +1,13 @@
 IMPROVEMENTS
 ---------------------
 
-- Recognize Attributes
-
-- Do not collapse single node in cycle graph
 - Highlight of aggregated edges takes too long. If quick help not visible skip?
 - Performance in general
 
 
+- Attributes are caught at class or method level. Not for the parameters like [CallerMemberName]
+
+
 BUGS
 ---------------------
 

CodeParser/Export/DgmlExport.cs

@@ -40,7 +40,7 @@ public void Export(string fileName, CodeGraph graph)
         foreach (var edge in normal)
         {
             // Omit the calls label for better readability.
-            var edgeLabel = edge.Type == DependencyType.Calls ? string.Empty : edge.Type.ToString();
+            var edgeLabel = GetEdgeLabel(edge);
             builder.AddEdgeById(edge.SourceId, edge.TargetId, edgeLabel);
         }
 
@@ -60,6 +60,33 @@ public void Export(string fileName, CodeGraph graph)
         builder.WriteOutput(fileName);
     }
 
+    private static string GetEdgeLabel(Dependency dependency)
+    {
+        // Omit the label text for now. The color makes it clear that it is a call dependency
+        if (dependency.Type == DependencyType.Calls)
+        {
+            return string.Empty;
+        }
+
+        // We can see this by the dotted line
+        if (dependency.Type == DependencyType.Implements || dependency.Type == DependencyType.Inherits)
+        {
+            return string.Empty;
+        }
+
+        if (dependency.Type == DependencyType.Uses)
+        {
+            return string.Empty;
+        }
+
+        if (dependency.Type == DependencyType.UsesAttribute)
+        {
+            return string.Empty;
+        }
+
+        return dependency.Type.ToString();
+    }
+
     private static void WriteCategories(DgmlFileBuilder writer)
     {
         var elementTypes = Enum.GetValues(typeof(CodeElementType)).Cast<CodeElementType>();

CodeParser/Parser/Parser.Phase1.cs

@@ -7,7 +7,7 @@ namespace CodeParser.Parser;
 
 public partial class Parser
 {
-    private readonly List<INamedTypeSymbol> AllNamedTypesInSolution = new();
+    private readonly List<INamedTypeSymbol> _allNamedTypesInSolution = new();
 
     private async Task BuildHierarchy(Solution solution)
     {
@@ -28,7 +28,7 @@ private async Task BuildHierarchy(Solution solution)
             // Build also a list of all named types in the solution
             // We need this in phase 2 to resolve dependencies
             var types = compilation.GetSymbolsWithName(_ => true, SymbolFilter.Type).OfType<INamedTypeSymbol>();
-            AllNamedTypesInSolution.AddRange(types);
+            _allNamedTypesInSolution.AddRange(types);
 
 
             BuildHierarchy(compilation);
@@ -145,8 +145,6 @@ private void ProcessNodeForHierarchy(SyntaxNode node, SemanticModel semanticMode
             case EventDeclarationSyntax:
                 symbol = semanticModel.GetDeclaredSymbol(node) as IEventSymbol;
                 elementType = CodeElementType.Event;
-
-
                 break;
             // Add more cases as needed (e.g., for events, delegates, etc.)
         }
@@ -161,6 +159,7 @@ private void ProcessNodeForHierarchy(SyntaxNode node, SemanticModel semanticMode
         }
         else
         {
+            // The parent gets the indirect children assigned as children
             foreach (var childNode in node.ChildNodes())
             {
                 ProcessNodeForHierarchy(childNode, semanticModel, parent);

CodeParser/Parser/Parser.Phase2.cs

@@ -44,6 +44,9 @@ private void AnalyzeDependencies(Solution solution)
                 AnalyzeFieldDependencies(element, fieldSymbol);
             }
 
+            // For all type of symbols check if decorated with an attribute.
+            AnalyzeAttributeDependencies(element, symbol);
+
             if (loop % 10 == 0)
             {
                 ParserProgress?.Invoke(this, new ParserProgressArg
@@ -56,6 +59,22 @@ private void AnalyzeDependencies(Solution solution)
         }
     }
 
+    private void AnalyzeAttributeDependencies(CodeElement element, ISymbol symbol)
+    {
+        foreach (var attributeData in symbol.GetAttributes())
+        {
+            if (attributeData.AttributeClass != null)
+            {
+                var location = attributeData.ApplicationSyntaxReference != null
+                    ? GetLocation(attributeData.ApplicationSyntaxReference.GetSyntax())
+                    : null;
+
+                element.Attributes.Add(attributeData.AttributeClass.Name);
+                AddTypeDependency(element, attributeData.AttributeClass, DependencyType.UsesAttribute, location);
+            }
+        }
+    }
+
     private void AnalyzeDelegateDependencies(CodeElement delegateElement, INamedTypeSymbol delegateSymbol)
     {
         var methodSymbol = delegateSymbol.DelegateInvokeMethod;
@@ -119,7 +138,7 @@ private void AnalyzeMethodDependencies(Solution solution, CodeElement methodElem
         // If this method is an interface method or an abstract method, find its implementations
         if (methodSymbol.IsAbstract || methodSymbol.ContainingType.TypeKind == TypeKind.Interface)
         {
-            FindImplementations(solution, methodElement, methodSymbol);
+            FindImplementations(methodElement, methodSymbol);
         }
 
         // Check for method override
@@ -150,7 +169,7 @@ private void AnalyzeMethodDependencies(Solution solution, CodeElement methodElem
     }
 
 
-    private void FindImplementations(Solution solution, CodeElement methodElement, IMethodSymbol methodSymbol)
+    private void FindImplementations(CodeElement methodElement, IMethodSymbol methodSymbol)
     {
         var implementingTypes = new HashSet<INamedTypeSymbol>(SymbolEqualityComparer.Default);
 
@@ -183,13 +202,13 @@ private void FindImplementations(Solution solution, CodeElement methodElement, I
 
     private IEnumerable<INamedTypeSymbol> FindTypesImplementingInterface(INamedTypeSymbol interfaceSymbol)
     {
-        return AllNamedTypesInSolution
+        return _allNamedTypesInSolution
             .Where(type => type.AllInterfaces.Any(i => SymbolEqualityComparer.Default.Equals(i, interfaceSymbol)));
     }
 
     private IEnumerable<INamedTypeSymbol> FindTypesDerivedFrom(INamedTypeSymbol baseType)
     {
-        return AllNamedTypesInSolution
+        return _allNamedTypesInSolution
             .Where(type => IsTypeDerivedFrom(type, baseType));
     }
 

CodeParserTests/CodeParserApprovalTests.cs

@@ -77,6 +77,9 @@ public void FindsAllFunctions()
             "CSharpLanguage.CSharpLanguage.MissingInterface.IStorage.Load",
             "CSharpLanguage.CSharpLanguage.NS_Parent.NS_Child.ClassNsChild.Method",
 
+            "CSharpLanguage.CSharpLanguage.IStructInterface.Method",
+            "CSharpLanguage.CSharpLanguage.StructWithInterface.Method",
+
             // Extension method
             "CSharpLanguage.CSharpLanguage.Extensions.Slice", 
 
@@ -177,7 +180,8 @@ public void FindsAllMethodImplementations()
         var expected = new HashSet<string>
         {
             "ModuleLevel1.ModuleLevel1.ServiceBase.Do -> ModuleLevel1.ModuleLevel1.IServiceC.Do",
-            "CSharpLanguage.CSharpLanguage.MissingInterface.BaseStorage.Load -> CSharpLanguage.CSharpLanguage.MissingInterface.IStorage.Load"
+            "CSharpLanguage.CSharpLanguage.MissingInterface.BaseStorage.Load -> CSharpLanguage.CSharpLanguage.MissingInterface.IStorage.Load",
+            "CSharpLanguage.CSharpLanguage.StructWithInterface.Method -> CSharpLanguage.CSharpLanguage.IStructInterface.Method"
         };
 
 

Contracts/Graph/CodeElement.cs

@@ -7,6 +7,12 @@ public class CodeElement(string id, CodeElementType elementType, string name, st
 {
     public List<SourceLocation> SourceLocations { get; set; } = [];
 
+    /// <summary>
+    /// Unlike in the dependency graph where external dependencies are omitted
+    /// I want to keep all attributes here.
+    /// </summary>
+    public HashSet<string> Attributes { get; set; } = [];
+
     public HashSet<CodeElement> Children { get; } = [];
 
     public HashSet<Dependency> Dependencies { get; } = [];

Contracts/Graph/DependencyType.cs

@@ -15,5 +15,7 @@ public enum DependencyType
     // Special dependency to model the hierarchy.
     // In the CodeElement this dependency is modeled via.
     // Parent / Children 
-    Containment
+    Containment,
+
+    UsesAttribute,
 }

Documentation/Cycle detection.md

@@ -8,17 +8,17 @@ The current cycle detection algorithm for code graphs has room for improvement.
 
 Initially, we attempted to detect cycles between code elements based on dependencies analyzed by the code parser. The naive assumption was that cycles between dependencies would induce cycles in higher-level containers (e.g., classes, namespaces). 
 
-![](Examples\class-by-field.png)
+![](Images/class-by-field.png)
 
 The two classes reference each other by their fields and form a class cycle. If the classes are in different namespaces there would be a cycle between the namespaces. The dependency arrows would cross the namespace boundaries.
 
 The algorithm could do this automatically if we include the parent-child relationships in the search graph.
 
-![](Examples\class-by-field-with-containment.png)
+![](Images/class-by-field-with-containment.png)
 
 However other situations do not automatically connect all related elements. In the image below there is no cycle formed, even by including the parent-child relationships.
 
-![](Examples\class-by-method-with-containment.png)
+![](Images/class-by-method-with-containment.png)
 
 Adding artificial **is-child-of** dependencies would cause cycles everywhere. 
 
@@ -32,7 +32,7 @@ Assume the following code graph is extracted from the source code.
 
 There is a cycle between **Namespace 2** and **Namespace 3,** caused by **Method 1** calling **Method 2** and **_field1** holding a reference to **Class 1.**
 
-![](Examples\solution-problem.png)
+![](Images/solution-problem.png)
 
 
 
@@ -48,7 +48,7 @@ Process:
 
 Here is what the search graph looks like:
 
-![](Examples\search-graph.png)
+![](Images/search-graph.png)
 
 Assume the call from **Method 1** to **Method 2.** The least common ancestor is **Namespace 1**, which is excluded. This results in **Namespace 2** and **Namespace 3** being the highest involved code elements in this **call** dependency.
 
@@ -80,7 +80,7 @@ Assume the following code graph. Here we have a namespace cycle between **Namesp
 
 
 
-![](Examples\edge-case-source-graph.png)
+![](Images/edge-case-source-graph.png)
 
 #### Handling containment in step 1
 
@@ -118,7 +118,7 @@ Following this procedure, only the green elements in the image below are conside
 
 The set difference operation is necessary because the sources should not be included in the targets, as **Namespace 2** is a child of **Namespace 1**.
 
-![](Examples\containment.png)
+![](Images/containment.png)
 
 
 
@@ -128,7 +128,7 @@ In the previously discussed scenario, namespaces play a crucial role. Is it poss
 
 Assume following scenario:
 
-![](Examples\nested_classes_code_graph.png)
+![](Images/nested_classes_code_graph.png)
 
 
 
@@ -138,7 +138,7 @@ The proxy dependencies are between **DirectClass** and **MiddleClass**.
 
 The resulting cycle looks like this
 
-![](Examples\nested_classes_scc.png)
+![](Images/nested_classes_scc.png)
 
 ## Conclusion