Further refactoring of label name code.

The ParseTreeView will now also display nodes by label names when the option is turned on.

Author: wiredwiz

Code Grapher/ParseTreeGrapher.cs

@@ -103,7 +103,7 @@ private void FormatNodes(Graph graph, ITree tree, IList<string> parserRules)
             var context = tree as ParserRuleContext;
 
             if (UseLabelNames && context != null)
-               node.LabelText = context.GetParserRuleName() ?? Trees.GetNodeText(tree, parserRules);
+               node.LabelText = context.GetLabeledRuleName() ?? Trees.GetNodeText(tree, parserRules);
             else
                node.LabelText = Trees.GetNodeText(tree, parserRules);
 

Common/Extensions/ITreeExtensions.cs

@@ -49,11 +49,11 @@ public static class ITreeExtensions
    {
 
       /// <summary>
-      /// Gets the parser rule name for the specified <see cref="ITree"/> instance.
+      /// Gets the labeled parser rule name for the specified <see cref="ITree"/> instance.
       /// </summary>
       /// <param name="tree">The tree instance.</param>
-      /// <returns>The resulting name or null if the rule name could not be resolved.</returns>
-      public static string GetParserRuleName(this ITree tree)
+      /// <returns>The resulting labeled name or null if the name could not be resolved.</returns>
+      public static string GetLabeledRuleName(this ITree tree)
       {
          if (tree is ParserRuleContext context)
          {

Common/Extensions/ParserRuleContextExtensions.cs

@@ -75,11 +75,11 @@ public static bool ContainsSourceSelection([NotNull] this ParserRuleContext cont
       }
 
       /// <summary>
-      /// Gets the rule name for the specified <see cref="ParserRuleContext"/> instance.
+      /// Gets the labeled rule name for the specified <see cref="ParserRuleContext"/> instance.
       /// </summary>
       /// <param name="context">The <see cref="ParserRuleContext"/> instance to use.</param>
-      /// <returns>The resulting name or null if the rule name could not be resolved.</returns>
-      public static string GetParserRuleName(this ParserRuleContext context)
+      /// <returns>The resulting labeled name or null if the name could not be resolved.</returns>
+      public static string GetLabeledRuleName(this ParserRuleContext context)
       {
          var className = context.GetType().Name;
          var labelEnd = className.LastIndexOf("Context", StringComparison.Ordinal);

GunWin/VisualAnalyzer.cs

@@ -991,6 +991,7 @@ private void TracingToolStripMenuItem_Click(object sender, EventArgs e)
 
       private void VisualAnalyzer_Load(object sender, EventArgs e)
       {
+         ParseTreeView.UseLabelNames = UseLabelNamesMnuItem.CheckState == CheckState.Checked;
          InitializeGraphCanvas();
          ConfigureGraphWorker();
          ConfigureParserMessageWindow();
@@ -1193,6 +1194,7 @@ private void WordWrapMnuItem_CheckStateChanged(object sender, EventArgs e)
       private void UseLabelNamesMnuItem_CheckStateChanged(object sender, EventArgs e)
       {
          _Grapher.UseLabelNames = UseLabelNamesMnuItem.CheckState == CheckState.Checked;
+         ParseTreeView.UseLabelNames = UseLabelNamesMnuItem.CheckState == CheckState.Checked;
          if (ParseTreeView.SelectedNode != null && ParseTreeView.SelectedNode.Tag is ITree selected) 
             RenderParseTreeGraph(selected, GraphZoomTrackBar.Value);
       }

ParserTreeView/ParserTreeView.cs

@@ -2,14 +2,27 @@
 using System.Collections.Generic;
 using System.Windows.Forms;
 using Antlr4.Runtime.Tree;
+using Org.Edgerunner.ANTLR4.Tools.Common.Extensions;
 using Org.Edgerunner.ANTLR4.Tools.Testing.Grammar;
 
 namespace Org.Edgerunner.ANTLR4.Tools.Testing
 {
    public partial class ParserTreeView : TreeView
    {
+      /// <summary>
+      /// Gets the grammar being used.
+      /// </summary>
+      /// <value>The grammar.</value>
       public GrammarReference Grammar { get; private set; }
+
+      /// <summary>
+      /// Gets or sets a value indicating whether [use label names].
+      /// </summary>
+      /// <value><c>true</c> if [use label names]; otherwise, <c>false</c>.</value>
+      public bool UseLabelNames { get; set; }
+
       public ITree ParseTree { get; private set; }
+
       private Dictionary<string, TreeNode> ActiveNodes { get; } = new Dictionary<string, TreeNode>();
 
       /// <summary>
@@ -230,7 +243,7 @@ private TreeNode AddChildNodeAndLeaves(TreeNode root, ITree tree)
          var nodeName = tree.GetHashCode().ToString();
          if (!ActiveNodes.TryGetValue(nodeName, out var treeNode))
          {
-            treeNode = new TreeNode(Trees.GetNodeText(tree, Grammar.ParserRules))
+            treeNode = new TreeNode(tree.GetLabeledRuleName() ?? Trees.GetNodeText(tree, Grammar.ParserRules))
             {
                Tag = tree,
                Name = nodeName
@@ -250,7 +263,8 @@ private TreeNode AddChildNodeAndLeaves(TreeNode root, ITree tree)
             nodeName = child.GetHashCode().ToString();
             if (ActiveNodes.ContainsKey(nodeName))
                continue;
-            var newChild = new TreeNode(Trees.GetNodeText(child, Grammar.ParserRules))
+
+            var newChild = new TreeNode(child.GetLabeledRuleName() ?? Trees.GetNodeText(child, Grammar.ParserRules))
             {
                Tag = child,
                Name = nodeName

ParserTreeView/ParserTreeView.csproj

@@ -58,6 +58,10 @@
     <None Include="packages.config" />
   </ItemGroup>
   <ItemGroup>
+    <ProjectReference Include="..\Common\Common.csproj">
+      <Project>{8bd992fd-a3b3-4af9-9371-5aa14ddfda68}</Project>
+      <Name>Common</Name>
+    </ProjectReference>
     <ProjectReference Include="..\Utilities\Utilities.csproj">
       <Project>{4e020f1d-27bf-4853-8573-474d7edb4e72}</Project>
       <Name>Utilities</Name>