Rename SyntaxNode.GetChildren to GetChild

xoofx · Jan 25, 2022 · 2ea2d1c · 2ea2d1c
1 parent 014e186
commit 2ea2d1c
Show file tree

Hide file tree

Showing 22 changed files with 50 additions and 45 deletions.
diff --git a/src/Tomlyn.Tests/SyntaxTests.cs b/src/Tomlyn.Tests/SyntaxTests.cs
@@ -40,10 +40,10 @@ public void TestDocument()
             table.AddLeadingComment("This is a comment");
             table.AddLeadingTriviaNewLine();
 
-            var firstElement = table.Items.GetChildren(0);
+            var firstElement = table.Items.GetChild(0);
             firstElement.AddTrailingComment("This is an item comment");
 
-            var secondElement = table.Items.GetChildren(2);
+            var secondElement = table.Items.GetChild(2);
             secondElement.AddLeadingTriviaNewLine();
             secondElement.AddLeadingComment("This is a comment in a middle of a table");
             secondElement.AddLeadingTriviaNewLine();

diff --git a/src/Tomlyn/Model/SyntaxToModelTransform.cs b/src/Tomlyn/Model/SyntaxToModelTransform.cs
@@ -154,7 +154,7 @@ private bool TryFollowKeyPath(KeySyntax key, SyntaxKind kind, out string name)
             {
                 return false;
             }
-            var nextItem = items.GetChildren(i);
+            var nextItem = items.GetChild(i);
             item = nextItem!;
             name = GetStringFromBasic(nextItem!.Key!) ?? string.Empty;
         }
@@ -290,7 +290,7 @@ public override void Visit(ArraySyntax array)
             var items = array.Items;
             for (int i = 0; i < items.ChildrenCount; i++)
             {
-                var item = items.GetChildren(i)!;
+                var item = items.GetChild(i)!;
                 item.Accept(this);
 
                 // Make sure that we can convert the item to the destination value
@@ -438,8 +438,8 @@ public override void Visit(InlineTableSyntax inlineTable)
                 metadata.LeadingTrivia = trivias;
             }
 
-            var lastChildren = keyValue.Value?.GetChildren(keyValue.Value.ChildrenCount - 1);
-            trivias = ConvertTrivias(lastChildren?.TrailingTrivia);
+            var lastChild = keyValue.Value?.GetChild(keyValue.Value.ChildrenCount - 1);
+            trivias = ConvertTrivias(lastChild?.TrailingTrivia);
             if (trivias != null && trivias.Count > 0)
             {
                 metadata ??= new TomlPropertyMetadata();
@@ -463,8 +463,8 @@ public override void Visit(InlineTableSyntax inlineTable)
                 metadata.LeadingTrivia = trivias;
             }
 
-            var lastChildren = tableSyntax.CloseBracket;
-            trivias = ConvertTrivias(lastChildren?.TrailingTrivia);
+            var lastChild = tableSyntax.CloseBracket;
+            trivias = ConvertTrivias(lastChild?.TrailingTrivia);
             if (trivias != null && trivias.Count > 0)
             {
                 metadata ??= new TomlPropertyMetadata();

diff --git a/src/Tomlyn/Syntax/ArrayItemSyntax.cs b/src/Tomlyn/Syntax/ArrayItemSyntax.cs
@@ -43,7 +43,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 2;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return index == 0 ? (SyntaxNode?)Value : Comma;
         }

diff --git a/src/Tomlyn/Syntax/ArraySyntax.cs b/src/Tomlyn/Syntax/ArraySyntax.cs
@@ -93,7 +93,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 3;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             switch (index)
             {

diff --git a/src/Tomlyn/Syntax/BareKeySyntax.cs b/src/Tomlyn/Syntax/BareKeySyntax.cs
@@ -46,7 +46,7 @@ public override void Accept(SyntaxVisitor visitor)
             visitor.Visit(this);
         }
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return Key;
         }

diff --git a/src/Tomlyn/Syntax/BooleanValueSyntax.cs b/src/Tomlyn/Syntax/BooleanValueSyntax.cs
@@ -54,7 +54,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 1;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return Token;
         }

diff --git a/src/Tomlyn/Syntax/DateTimeValueSyntax.cs b/src/Tomlyn/Syntax/DateTimeValueSyntax.cs
@@ -42,7 +42,7 @@ public override void Accept(SyntaxVisitor visitor)
             visitor.Visit(this);
         }
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return Token;
         }

diff --git a/src/Tomlyn/Syntax/DocumentSyntax.cs b/src/Tomlyn/Syntax/DocumentSyntax.cs
@@ -45,7 +45,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 2;
 
-        protected override SyntaxNode GetChildrenImpl(int index)
+        protected override SyntaxNode GetChildImpl(int index)
         {
             return index == 0 ? (SyntaxNode)KeyValues : Tables;
         }

diff --git a/src/Tomlyn/Syntax/DottedKeyItemSyntax.cs b/src/Tomlyn/Syntax/DottedKeyItemSyntax.cs
@@ -56,7 +56,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 2;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return index == 0 ? (SyntaxNode?)Dot : Key;
         }

diff --git a/src/Tomlyn/Syntax/FloatValueSyntax.cs b/src/Tomlyn/Syntax/FloatValueSyntax.cs
@@ -69,7 +69,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 1;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return Token;
         }

diff --git a/src/Tomlyn/Syntax/InlineTableItemSyntax.cs b/src/Tomlyn/Syntax/InlineTableItemSyntax.cs
@@ -54,7 +54,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 2;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return index == 0 ? (SyntaxNode?)KeyValue : Comma;
         }

diff --git a/src/Tomlyn/Syntax/InlineTableSyntax.cs b/src/Tomlyn/Syntax/InlineTableSyntax.cs
@@ -71,7 +71,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 3;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             switch (index)
             {

diff --git a/src/Tomlyn/Syntax/IntegerValueSyntax.cs b/src/Tomlyn/Syntax/IntegerValueSyntax.cs
@@ -49,7 +49,7 @@ public override void Accept(SyntaxVisitor visitor)
         }
         public override int ChildrenCount => 1;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return Token;
         }

diff --git a/src/Tomlyn/Syntax/KeySyntax.cs b/src/Tomlyn/Syntax/KeySyntax.cs
@@ -63,7 +63,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 2;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             if (index == 0) return Key;
             return DotKeys;

diff --git a/src/Tomlyn/Syntax/KeyValueSyntax.cs b/src/Tomlyn/Syntax/KeyValueSyntax.cs
@@ -97,7 +97,7 @@ public override void Accept(SyntaxVisitor visitor)
             visitor.Visit(this);
         }
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             switch (index)
             {

diff --git a/src/Tomlyn/Syntax/StringValueSyntax.cs b/src/Tomlyn/Syntax/StringValueSyntax.cs
@@ -52,7 +52,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 1;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return Token;
         }

diff --git a/src/Tomlyn/Syntax/SyntaxList.cs b/src/Tomlyn/Syntax/SyntaxList.cs
@@ -22,7 +22,7 @@ internal SyntaxList() : base(SyntaxKind.List)
 
         public sealed override int ChildrenCount => Children.Count;
 
-        protected override SyntaxNode GetChildrenImpl(int index)
+        protected override SyntaxNode GetChildImpl(int index)
         {
             return Children[index];
         }
@@ -58,12 +58,12 @@ public void Add(TSyntaxNode node)
             node.Parent = this;
         }
 
-        public new TSyntaxNode? GetChildren(int index)
+        public new TSyntaxNode? GetChild(int index)
         {
-            return (TSyntaxNode?)base.GetChildren(index);
+            return (TSyntaxNode?)base.GetChild(index);
         }
 
-        protected override SyntaxNode GetChildrenImpl(int index)
+        protected override SyntaxNode GetChildImpl(int index)
         {
             return Children[index];
         }
@@ -72,7 +72,7 @@ protected override SyntaxNode GetChildrenImpl(int index)
         /// Removes a node at the specified index.
         /// </summary>
         /// <param name="index">Index of the node to remove</param>
-        public void RemoveChildrenAt(int index)
+        public void RemoveChildAt(int index)
         {
             var node = Children[index];
             Children.RemoveAt(index);
@@ -83,7 +83,7 @@ public void RemoveChildrenAt(int index)
         /// Removes the specified node instance.
         /// </summary>
         /// <param name="node">Node instance to remove</param>
-        public void RemoveChildren(TSyntaxNode node)
+        public void RemoveChild(TSyntaxNode node)
         {
             if (node == null) throw new ArgumentNullException(nameof(node));
             if (node.Parent != this) throw new InvalidOperationException("The node is not part of this list");

diff --git a/src/Tomlyn/Syntax/SyntaxNode.cs b/src/Tomlyn/Syntax/SyntaxNode.cs
@@ -3,6 +3,7 @@
 // See license.txt file in the project root for full license information.
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.IO;
 using Tomlyn.Helpers;
 
@@ -34,30 +35,30 @@ protected SyntaxNode(SyntaxKind kind)
         public List<SyntaxTrivia>? TrailingTrivia { get; set; }
 
         /// <summary>
-        /// Gets the number of children
+        /// Gets the number of children.
         /// </summary>
         public abstract int ChildrenCount { get; }
 
         /// <summary>
-        /// Gets a children at the specified index.
+        /// Gets a child at the specified index.
         /// </summary>
-        /// <param name="index">Index of the children</param>
-        /// <returns>A children at the specified index</returns>
-        public SyntaxNode? GetChildren(int index)
+        /// <param name="index">Index of the child</param>
+        /// <returns>A child at the specified index</returns>
+        public SyntaxNode? GetChild(int index)
         {
             if (index < 0) throw ThrowHelper.GetIndexNegativeArgumentOutOfRangeException();
             if (index > ChildrenCount) throw ThrowHelper.GetIndexArgumentOutOfRangeException(ChildrenCount);
-            return GetChildrenImpl(index);
+            return GetChildImpl(index);
         }
 
         /// <summary>
-        /// Gets a children at the specified index.
+        /// Gets a child at the specified index.
         /// </summary>
-        /// <param name="index">Index of the children</param>
-        /// <returns>A children at the specified index</returns>
+        /// <param name="index">Index of the child</param>
+        /// <returns>A child at the specified index</returns>
         /// <remarks>The index is safe to use</remarks>
-        protected abstract SyntaxNode? GetChildrenImpl(int index);
-
+        protected abstract SyntaxNode? GetChildImpl(int index);
+        
         public override string ToString()
         {
             var writer = new StringWriter();
@@ -87,7 +88,7 @@ private void WriteToInternal(TextWriter writer)
                 int count = ChildrenCount;
                 for (int i = 0; i < count; i++)
                 {
-                    var child = GetChildren(i);
+                    var child = GetChild(i);
                     if (child == null) continue;
                     child.WriteToInternal(writer);
                 }

diff --git a/src/Tomlyn/Syntax/SyntaxToken.cs b/src/Tomlyn/Syntax/SyntaxToken.cs
@@ -43,7 +43,7 @@ public override void Accept(SyntaxVisitor visitor)
 
         public override int ChildrenCount => 0;
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             return null;
         }

diff --git a/src/Tomlyn/Syntax/SyntaxValidator.cs b/src/Tomlyn/Syntax/SyntaxValidator.cs
@@ -229,7 +229,7 @@ private bool KeyNameToObjectPath(KeySyntax key, ObjectKind kind, bool fromDotted
             for (int i = 0; i < items.ChildrenCount; i++)
             {
                 AddObjectPath(key, kind, true, fromDottedKeys);
-                var dotItem = GetStringFromBasic(items.GetChildren(i)!.Key!)!;
+                var dotItem = GetStringFromBasic(items.GetChild(i)!.Key!)!;
                 if (string.IsNullOrWhiteSpace(dotItem)) return false;
                 _currentPath.Add(dotItem);
             }
@@ -313,7 +313,7 @@ public override void Visit(ArraySyntax array)
             SyntaxKind firstKind = default;
             for(int i = 0; i < items.ChildrenCount; i++)
             {
-                var item = items.GetChildren(i)!;
+                var item = items.GetChild(i)!;
                 var value = item.Value!;
                 if (i == 0)
                 {

diff --git a/src/Tomlyn/Syntax/SyntaxVisitor.cs b/src/Tomlyn/Syntax/SyntaxVisitor.cs
@@ -94,7 +94,7 @@ public virtual void DefaultVisit(SyntaxNode? node)
 
             for (int i = 0; i < node.ChildrenCount; i++)
             {
-                var child = node.GetChildren(i);
+                var child = node.GetChild(i);
                 if (child != null)
                 {
                     child.Accept(this);

diff --git a/src/Tomlyn/Syntax/TableSyntaxBase.cs b/src/Tomlyn/Syntax/TableSyntaxBase.cs
@@ -1,6 +1,10 @@
 // Copyright (c) Alexandre Mutel. All rights reserved.
 // Licensed under the BSD-Clause 2 license. 
 // See license.txt file in the project root for full license information.
+
+using Tomlyn.Helpers;
+using Tomlyn.Model;
+
 namespace Tomlyn.Syntax
 {
     /// <summary>
@@ -65,7 +69,7 @@ public SyntaxToken? EndOfLineToken
 
         internal abstract TokenKind CloseTokenKind { get; }
 
-        protected override SyntaxNode? GetChildrenImpl(int index)
+        protected override SyntaxNode? GetChildImpl(int index)
         {
             switch (index)
             {