Merge pull request #125 from qq792453582/master

add keep_indents_on_empty_lines option

Author: CppCXY

CodeFormatCore/include/CodeFormatCore/Config/LuaStyle.h

@@ -116,6 +116,12 @@ class LuaStyle {
 
     bool never_indent_comment_on_if_branch = false;
 
+    /*
+     * if true retains indents on empty lines as if they contained some code
+     * if false deletes the tab characters and spaces on empty lines 
+     */
+    bool keep_indents_on_empty_lines = false;
+
     // [line space]
 
     LineSpace line_space_after_if_statement = LineSpace(LineSpaceType::Keep);

CodeFormatCore/include/CodeFormatCore/Format/FormatBuilder.h

@@ -15,13 +15,16 @@ class FormatBuilder {
     explicit FormatBuilder(LuaStyle &style);
 
     virtual std::string GetFormatResult(const LuaSyntaxTree &t);
+
 protected:
     void DoResolve(LuaSyntaxNode &syntaxNode, const LuaSyntaxTree &t, FormatResolve &resolve);
 
     virtual void WriteSyntaxNode(LuaSyntaxNode &syntaxNode, const LuaSyntaxTree &t);
 
     virtual void WriteSpace(std::size_t space);
 
+    void AddEndOfLine(std::size_t line);
+
     virtual void WriteLine(std::size_t line);
 
     virtual void WriteIndent();

CodeFormatCore/src/Config/LuaStyle.cpp

@@ -220,6 +220,8 @@ void LuaStyle::Parse(std::map<std::string, std::string, std::less<>> &configMap)
 
     BOOL_OPTION(never_indent_comment_on_if_branch)
 
+    BOOL_OPTION(keep_indents_on_empty_lines)
+
     std::vector<std::pair<std::string, LineSpace &>> fieldList = {
             {"line_space_after_if_statement",              line_space_after_if_statement             },
             {"line_space_after_do_statement",              line_space_after_do_statement             },

CodeFormatCore/src/Format/FormatBuilder.cpp

@@ -251,22 +251,7 @@ void FormatBuilder::WriteSpace(std::size_t space) {
     _state.CurrentWidth() += space;
 }
 
-void FormatBuilder::WriteLine(std::size_t line) {
-    if (line == 0) {
-        return;
-    }
-    // trim end space
-    auto lastIndex = _formattedText.size();
-    std::size_t reduce = 0;
-    while (_formattedText[lastIndex - reduce - 1] == ' ') {
-        reduce++;
-        if (lastIndex <= reduce + 1) {
-            break;
-        }
-    }
-    if (reduce > 0) {
-        _formattedText.resize(_formattedText.size() - reduce);
-    }
+void FormatBuilder::AddEndOfLine(std::size_t line) {
     auto endOfLine = _state.GetEndOfLine();
     switch (endOfLine) {
         case EndOfLine::CRLF: {
@@ -304,6 +289,35 @@ void FormatBuilder::WriteLine(std::size_t line) {
     _state.CurrentWidth() = 0;
 }
 
+void FormatBuilder::WriteLine(std::size_t line) {
+    if (line == 0) {
+        return;
+    }
+    // trim end space
+    auto lastIndex = _formattedText.size();
+    std::size_t reduce = 0;
+    while (_formattedText[lastIndex - reduce - 1] == ' ') {
+        reduce++;
+        if (lastIndex <= reduce + 1) {
+            break;
+        }
+    }
+    if (reduce > 0) {
+        _formattedText.resize(_formattedText.size() - reduce);
+    }
+
+    if (line > 1 && _state.GetStyle().keep_indents_on_empty_lines) {
+        AddEndOfLine(1);
+
+        for (int i = 1; i < line; ++i) {
+            WriteIndent();
+            AddEndOfLine(1);
+        }
+    } else {
+        AddEndOfLine(line);
+    }
+}
+
 void FormatBuilder::WriteIndent() {
     auto topLevelIndent = _state.GetCurrentIndent();
     switch (_state.GetStyle().indent_style) {

Test/src/FormatStyle_unitest.cpp

@@ -1680,3 +1680,75 @@ local table1 = { 1, 2, 3 }
 )",
             style));
 }
+
+TEST(FormatByStyleOption, keep_indents_on_empty_lines) {
+    LuaStyle style;
+
+    style.keep_indents_on_empty_lines = true;
+    EXPECT_TRUE(TestHelper::TestFormatted(
+            R"(
+local t = function()  local a = 131
+
+
+    local b = function()
+        local c = {
+        }
+    end
+end
+      
+local t2 = function()
+    local c = 1
+end
+)",
+            R"(
+local t = function()
+    local a = 131
+    
+    
+    local b = function()
+        local c = {
+        }
+    end
+end
+
+local t2 = function()
+    local c = 1
+end
+
+)",
+            style));
+    
+    style.keep_indents_on_empty_lines = false;
+    EXPECT_TRUE(TestHelper::TestFormatted(
+            R"(
+local t = function()  local a = 131
+
+
+    local b = function()
+        local c = {
+        }
+    end
+end
+      
+local t2 = function()
+    local c = 1
+end
+)",
+            R"(
+local t = function()
+    local a = 131
+
+
+    local b = function()
+        local c = {
+        }
+    end
+end
+
+local t2 = function()
+    local c = 1
+end
+
+)",
+            style));
+}