Merge pull request #5912 from retailcoder/next

Introduce ISimpleIndenter

Author: retailcoder

Rubberduck.SmartIndenter/AbsoluteCodeLine.cs

@@ -7,7 +7,7 @@
 
 namespace Rubberduck.SmartIndenter
 {
-    internal class AbsoluteCodeLine
+    public class AbsoluteCodeLine
     {
         private const string StupidLineEnding = ": _";
         private static readonly Regex LineNumberRegex = new Regex(@"^(?<number>(-?\d+)|(&H[0-9A-F]{1,8}))(?<separator>:)?\s+(?<code>.*)", RegexOptions.ExplicitCapture | RegexOptions.IgnoreCase);

Rubberduck.SmartIndenter/IIndenter.cs

@@ -1,16 +1,13 @@
-using System.Collections.Generic;
-using Rubberduck.VBEditor.SafeComWrappers.Abstract;
+using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
 namespace Rubberduck.SmartIndenter
 {
-    public interface IIndenter
+
+    public interface IIndenter : ISimpleIndenter
     {
         void IndentCurrentProcedure();
         void IndentCurrentModule();
         void IndentCurrentProject();
         void Indent(IVBComponent component);
-        IEnumerable<string> Indent(string code);
-        IEnumerable<string> Indent(IEnumerable<string> lines);
-        IEnumerable<string> Indent(IEnumerable<string> codeLines, bool forceTrailingNewLines);
     }
 }

Rubberduck.SmartIndenter/ISimpleIndenter.cs

@@ -0,0 +1,11 @@
+using System.Collections.Generic;
+
+namespace Rubberduck.SmartIndenter
+{
+    public interface ISimpleIndenter
+    {
+        IEnumerable<string> Indent(string code, IIndenterSettings settings = null);
+        IEnumerable<string> Indent(IEnumerable<string> lines, IIndenterSettings settings = null);
+        IEnumerable<string> Indent(IEnumerable<string> codeLines, bool forceTrailingNewLines, IIndenterSettings settings = null);
+    }
+}

Rubberduck.SmartIndenter/Indenter.cs

@@ -1,13 +1,11 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
 using Rubberduck.VBEditor;
 using Rubberduck.VBEditor.SafeComWrappers;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
 namespace Rubberduck.SmartIndenter
 {
-    public class Indenter : IIndenter
+    public sealed class Indenter : SimpleIndenter, IIndenter
     {
         private readonly IVBE _vbe;
         private readonly Func<IIndenterSettings> _settings;
@@ -18,6 +16,8 @@ public Indenter(IVBE vbe, Func<IIndenterSettings> settings)
             _settings = settings;
         }
 
+        protected override Func<IIndenterSettings> Settings => _settings;
+
         /// <summary>
         /// Indents the procedure selected in the ActiveCodePane. If more than one is selected, the first is indented.
         /// </summary>
@@ -152,7 +152,7 @@ public void Indent(IVBComponent component)
                 }
 
                 var codeLines = module.GetLines(1, lineCount).Replace("\r", string.Empty).Split('\n');
-                var indented = Indent(codeLines, true);
+                var indented = Indent(codeLines, true, _settings.Invoke());
 
                 module.DeleteLines(1, lineCount);
                 module.InsertLines(1, string.Join("\r\n", indented));
@@ -180,7 +180,7 @@ private void Indent(IVBComponent component, Selection selection, bool procedure
                 var codeLines = module.GetLines(selection.StartLine, selection.LineCount).Replace("\r", string.Empty)
                     .Split('\n');
 
-                var indented = Indent(codeLines, false, procedure);
+                var indented = Indent(codeLines, false, procedure, _settings.Invoke());
 
                 var start = selection.StartLine;
                 var lines = selection.LineCount;
@@ -190,234 +190,5 @@ private void Indent(IVBComponent component, Selection selection, bool procedure
                 module.InsertLines(start, string.Join("\r\n", indented));
             }
         }
-
-        private IEnumerable<LogicalCodeLine> BuildLogicalCodeLines(IEnumerable<string> lines, out IIndenterSettings settings)
-        {
-            settings = _settings.Invoke();
-            var logical = new List<LogicalCodeLine>();
-            LogicalCodeLine current = null;
-            AbsoluteCodeLine previous = null;
-
-            foreach (var line in lines)
-            {
-                var absolute = new AbsoluteCodeLine(line, settings, previous);
-                if (current == null)
-                {
-                    current = new LogicalCodeLine(absolute, settings);
-                    logical.Add(current);
-                }
-                else
-                {
-                    current.AddContinuationLine(absolute);
-                }
-
-                if (!absolute.HasContinuation)
-                {
-                    current = null;
-                }
-                previous = absolute;
-            }
-            return logical;
-        }
-
-        /// <summary>
-        /// Indents the code contained in the passed string. NOTE: This overload should only be used on procedures or modules.
-        /// </summary>
-        /// <param name="code">The code block to indent</param>
-        /// <returns>Indented code lines</returns>
-        public IEnumerable<string> Indent(string code)
-        {
-            return Indent(code.Replace("\r", string.Empty).Split('\n'), false);
-        }
-
-        /// <summary>
-        /// Indents a range of code lines. NOTE: If inserting procedures, use the forceTrailingNewLines overload to preserve vertical spacing in the module.
-        /// Do not call directly on selections. Use Indent(IVBComponent, Selection) instead.
-        /// </summary>
-        /// <param name="codeLines">Code lines to indent</param>
-        /// <returns>Indented code lines</returns>
-        public IEnumerable<string> Indent(IEnumerable<string> codeLines)
-        {
-            return Indent(codeLines, false);
-        }
-
-        /// <summary>
-        /// Indents a range of code lines. Do not call directly on selections. Use Indent(IVBComponent, Selection) instead.
-        /// </summary>
-        /// <param name="codeLines">Code lines to indent</param>
-        /// <param name="forceTrailingNewLines">If true adds a number of blank lines after the last procedure based on VerticallySpaceProcedures settings</param>
-        /// <returns>Indented code lines</returns>
-        public IEnumerable<string> Indent(IEnumerable<string> codeLines, bool forceTrailingNewLines)
-        {
-            return Indent(codeLines, forceTrailingNewLines, false);
-        }
-
-        private IEnumerable<string> Indent(IEnumerable<string> codeLines, bool forceTrailingNewLines, bool procedure)
-        {
-            var logical = BuildLogicalCodeLines(codeLines, out var settings).ToList();
-            var indents = 0;
-            var start = false;
-            var enumStart = false;
-            var inEnumType = false;
-            var inProcedure = false;
-
-            foreach (var line in logical)
-            {
-                inEnumType &= !line.IsEnumOrTypeEnd;
-                if (inEnumType)
-                {
-                    line.AtEnumTypeStart = enumStart;
-                    enumStart = line.IsCommentBlock;
-                    line.IsEnumOrTypeMember = true;
-                    line.InsideProcedureTypeOrEnum = true;
-                    line.IndentationLevel = line.EnumTypeIndents;                    
-                    continue;
-                }
-
-                if (line.IsProcedureStart)
-                {
-                    inProcedure = true;                    
-                }                               
-                line.InsideProcedureTypeOrEnum = inProcedure || enumStart;
-                inProcedure = inProcedure && !line.IsProcedureEnd && !line.IsEnumOrTypeEnd;
-                if (line.IsProcedureStart || line.IsEnumOrTypeStart)
-                {
-                    indents = 0;
-                }
-
-                line.AtProcedureStart = start;
-                line.IndentationLevel = indents - line.Outdents;
-                indents += line.NextLineIndents;
-                start = line.IsProcedureStart || 
-                        line.AtProcedureStart && line.IsDeclaration ||
-                        line.AtProcedureStart && line.IsCommentBlock ||
-                        settings.IgnoreEmptyLinesInFirstBlocks && line.AtProcedureStart && line.IsEmpty;
-                inEnumType = line.IsEnumOrTypeStart;
-                enumStart = inEnumType;
-            }
-
-            return GenerateCodeLineStrings(logical, forceTrailingNewLines, procedure);
-        }
-
-        private IEnumerable<string> GenerateCodeLineStrings(IEnumerable<LogicalCodeLine> logical, bool forceTrailingNewLines, bool procedure = false)
-        {
-            var output = new List<string>();
-            var settings = _settings.Invoke();
-
-            List<LogicalCodeLine> indent;
-            if (!procedure && settings.VerticallySpaceProcedures)
-            {               
-                indent = new List<LogicalCodeLine>();
-                var lines = logical.ToArray();
-                var header = true;
-                var inEnumType = false;
-                var propertyGroupIdentifier = string.Empty;
-
-                for (var i = 0; i < lines.Length; i++)
-                {
-                    indent.Add(lines[i]);
-
-                    if (header && lines[i].IsEnumOrTypeStart)
-                    {
-                        inEnumType = true;
-                    }
-                    if (header && lines[i].IsEnumOrTypeEnd)
-                    {
-                        inEnumType = false;
-                    }
-
-                    if (header && !inEnumType && lines[i].IsProcedureStart)
-                    {
-                        header = false;
-                        SpaceHeader(indent, settings);
-
-                        propertyGroupIdentifier = lines[i].IsPropertyStart
-                            ? ExtractPropertyIdentifier(lines[i].ToString())
-                            : string.Empty;
-
-                        continue;
-                    }
-                    if (!lines[i].IsEnumOrTypeEnd && !lines[i].IsProcedureEnd)
-                    {
-                        continue;
-                    }
-
-                    while (++i < lines.Length && lines[i].IsEmpty) { }
-                    if (i != lines.Length)
-                    {
-                        var linesBetweenProcedures = settings.LinesBetweenProcedures;
-
-                        if (lines[i].IsPropertyStart)
-                        {
-                            var propertyIdentifier = ExtractPropertyIdentifier(lines[i].ToString());
-                            if (propertyIdentifier.Equals(propertyGroupIdentifier, StringComparison.InvariantCultureIgnoreCase)
-                                && settings.GroupRelatedProperties)
-                            {
-                                linesBetweenProcedures = 0;
-                            }
-                            else
-                            {
-                                propertyGroupIdentifier = propertyIdentifier;
-                            }
-                        }
-
-                        if (linesBetweenProcedures > 0)
-                        {
-                            indent.Add(new LogicalCodeLine(Enumerable.Repeat(new AbsoluteCodeLine(string.Empty, settings), linesBetweenProcedures), settings));
-                        }
-
-                        indent.Add(lines[i]);
-                    }
-                    else if (forceTrailingNewLines && i == lines.Length)
-                    {
-                        indent.Add(new LogicalCodeLine(Enumerable.Repeat(new AbsoluteCodeLine(string.Empty, settings), Math.Max(settings.LinesBetweenProcedures, 1)), settings));
-                    }
-                }
-            }
-            else
-            {
-                indent = logical.ToList();
-            }
-
-            foreach (var line in indent)
-            {
-                output.AddRange(line.Indented().Split(new[] { Environment.NewLine }, StringSplitOptions.None));
-            }
-            return output;
-        }
-
-        private static string ExtractPropertyIdentifier(string line)
-        {
-            var declarationElementsStartingAtGetLetOrSet = line.ToString().Split(' ').SkipWhile(c => !c.EndsWith("et")).ToArray();
-            return declarationElementsStartingAtGetLetOrSet[1].Split(new string[] { "(" }, StringSplitOptions.None).FirstOrDefault();
-        }
-
-        private static void SpaceHeader(IList<LogicalCodeLine> header, IIndenterSettings settings)
-        {
-            var commentSkipped = false;
-            var commentLines = 0;
-            for (var i = header.Count - 2; i >= 0; i--)
-            {
-                if (!commentSkipped && header[i].IsCommentBlock)
-                {
-                    commentLines++;
-                    continue;
-                }
-
-                commentSkipped = true;
-                if (header[i].IsEmpty)
-                {
-                    header.RemoveAt(i);
-                }
-                else
-                {
-                    header.Insert(header.Count - 1 - commentLines,
-                        new LogicalCodeLine(
-                            Enumerable.Repeat(new AbsoluteCodeLine(string.Empty, settings),
-                                settings.LinesBetweenProcedures), settings));
-                    return;
-                }
-            }
-        }
     }
 }

Rubberduck.SmartIndenter/LogicalCodeLine.cs

@@ -5,7 +5,7 @@
 
 namespace Rubberduck.SmartIndenter
 {
-    internal class LogicalCodeLine
+    public class LogicalCodeLine
     {
         private readonly List<AbsoluteCodeLine> _lines = new List<AbsoluteCodeLine>();
         private AbsoluteCodeLine _rebuilt;