Merge pull request swiftlang#5548 from dduan/indent_switch_case_block

dduan · web-flow · commit e5fc320a2129 · 2016-11-04T00:35:46.000-07:00
[swift-format] add option to indent switch block
diff --git a/include/swift/IDE/Formatting.h b/include/swift/IDE/Formatting.h
@@ -17,7 +17,9 @@ namespace swift {
 namespace ide {
 
 struct CodeFormatOptions {
+public:
   bool UseTabs = false;
+  bool IndentSwitchCase = false;
   unsigned IndentWidth = 4;
   unsigned TabWidth = 4;
 };
diff --git a/include/swift/Option/Options.td b/include/swift/Option/Options.td
@@ -336,6 +336,11 @@ def use_tabs : Flag<["-"], "use-tabs">, Group<code_formatting_Group>,
   Flags<[NoInteractiveOption, NoBatchOption, SwiftFormatOption]>,
   HelpText<"Use tabs for indentation.">;
 
+def indent_switch_case : Flag<["-"], "indent-switch-case">,
+  Group<code_formatting_Group>,
+  Flags<[NoInteractiveOption, NoBatchOption, SwiftFormatOption]>,
+  HelpText<"Indent cases in switch statements.">;
+
 def in_place : Flag<["-"], "in-place">, Group<code_formatting_Group>,
   Flags<[NoInteractiveOption, NoBatchOption, SwiftFormatOption]>,
   HelpText<"Overwrite input file with formatted file.">;
diff --git a/lib/IDE/Formatting.cpp b/lib/IDE/Formatting.cpp
@@ -88,6 +88,14 @@ class FormatContext {
     return InCommentLine;
   }
 
+  bool isSwitchControlStmt(unsigned LineIndex, StringRef Text) {
+    if (!isSwitchContext())
+      return false;
+    StringRef LineText = swift::ide::getTrimmedTextForLine(LineIndex, Text);
+    return LineText.startswith("break") || LineText.startswith("continue") ||
+      LineText.startswith("return") || LineText.startswith("fallthrough");
+  }
+
   void padToSiblingColumn(StringBuilder &Builder) {
     assert(SiblingInfo.Loc.isValid() && "No sibling to align with.");
     CharSourceRange Range(SM, Lexer::getLocForStartOfLine(SM, SiblingInfo.Loc),
@@ -248,7 +256,8 @@ class FormatContext {
     return E->getEndLoc().isValid() && SM.getLineNumber(E->getEndLoc()) == Line;
   };
 
-  bool shouldAddIndentForLine(unsigned Line, TokenInfo TInfo) {
+  bool shouldAddIndentForLine(unsigned Line, TokenInfo TInfo,
+                              const CodeFormatOptions &FmtOptions) {
     if (Cursor == Stack.rend())
       return false;
 
@@ -276,7 +285,7 @@ class FormatContext {
       // case xyz: <-- No indent here, should be at same level as switch.
       Stmt *AtStmtStart = Start.getAsStmt();
       if (AtStmtStart && isa<CaseStmt>(AtStmtStart))
-        return false;
+        return FmtOptions.IndentSwitchCase;
 
       // If we're at the open brace of the switch, don't add an indent.
       // For example:
@@ -292,7 +301,7 @@ class FormatContext {
           // // case comment <-- No indent here.
           // case 0:
           if (SM.getLineAndColumn(Case->swift::Stmt::getStartLoc()).first == Line + 1)
-            return false;
+            return FmtOptions.IndentSwitchCase;
         }
       }
     }
@@ -813,8 +822,18 @@ class CodeFormatter {
       ExpandedIndent -= ExpandedIndent % Width;
     };
 
-    if (LineAndColumn.second > 0 && FC.shouldAddIndentForLine(LineIndex, ToInfo))
+    if (LineAndColumn.second > 0 &&
+        FC.shouldAddIndentForLine(LineIndex, ToInfo, FmtOptions))
       AddIndentFunc();
+
+    // Control statements in switch align with the rest of the block in case.
+    // For example:
+    // switch ... {
+    //   case xyz:
+    //     break <-- Extra indent level here.
+    if (FmtOptions.IndentSwitchCase && FC.isSwitchControlStmt(LineIndex, Text))
+      AddIndentFunc();
+
     if (FC.IsInDocCommentBlock()) {
 
       // Inside doc comment block, the indent is one space, e.g.
diff --git a/test/swift-format/main.swift b/test/swift-format/main.swift
@@ -4,12 +4,23 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-range 12:18 %s >%t.response
+// RUN: %swift-format -line-range 24:29 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
+// RUN: %swift-format -indent-switch-case %s >%t.response
+// RUN: diff -u %s.indentswitch.response %t.response
 
 import Foundation
 
-func collatz(n: Int) {
+func collatz(n: Int, m: String?) {
+switch m {
+    case .some(let s):
+            print(s)
+case .none:
+print("nothing")
+default:
+    print("not possible")
+break
+    }
  var r: Int
     if n%2 == 0 {
           r = n/2
diff --git a/test/swift-format/main.swift.indent2.response b/test/swift-format/main.swift.indent2.response
@@ -4,12 +4,23 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-range 12:18 %s >%t.response
+// RUN: %swift-format -line-range 24:29 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
+// RUN: %swift-format -indent-switch-case %s >%t.response
+// RUN: diff -u %s.indentswitch.response %t.response
 
 import Foundation
 
-func collatz(n: Int) {
+func collatz(n: Int, m: String?) {
+  switch m {
+  case .some(let s):
+    print(s)
+  case .none:
+    print("nothing")
+  default:
+    print("not possible")
+    break
+  }
   var r: Int
   if n%2 == 0 {
     r = n/2
diff --git a/test/swift-format/main.swift.indentswitch.response b/test/swift-format/main.swift.indentswitch.response
@@ -0,0 +1,36 @@
+// RUN: %swift-format %s >%t.response
+// RUN: diff -u %s.response %t.response
+// RUN: %swift-format -indent-width 2 %s >%t.response
+// RUN: diff -u %s.indent2.response %t.response
+// RUN: %swift-format -use-tabs %s >%t.response
+// RUN: diff -u %s.tabs.response %t.response
+// RUN: %swift-format -line-range 24:29 %s >%t.response
+// RUN: diff -u %s.lines.response %t.response
+// RUN: %swift-format -indent-switch-case %s >%t.response
+// RUN: diff -u %s.indentswitch.response %t.response
+
+import Foundation
+
+func collatz(n: Int, m: String?) {
+    switch m {
+        case .some(let s):
+            print(s)
+        case .none:
+            print("nothing")
+        default:
+            print("not possible")
+            break
+    }
+    var r: Int
+    if n%2 == 0 {
+        r = n/2
+    } else {
+        r = 3*n+1
+    }
+    print("Number: \(r)")
+    if r == 1 {
+        print("Reached one!")
+    } else {
+        collatz(r)
+    }
+}
diff --git a/test/swift-format/main.swift.lines.response b/test/swift-format/main.swift.lines.response
@@ -4,12 +4,23 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-range 12:18 %s >%t.response
+// RUN: %swift-format -line-range 24:29 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
+// RUN: %swift-format -indent-switch-case %s >%t.response
+// RUN: diff -u %s.indentswitch.response %t.response
 
 import Foundation
 
-func collatz(n: Int) {
+func collatz(n: Int, m: String?) {
+switch m {
+    case .some(let s):
+            print(s)
+case .none:
+print("nothing")
+default:
+    print("not possible")
+break
+    }
     var r: Int
     if n%2 == 0 {
         r = n/2
diff --git a/test/swift-format/main.swift.response b/test/swift-format/main.swift.response
@@ -4,12 +4,23 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-range 12:18 %s >%t.response
+// RUN: %swift-format -line-range 24:29 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
+// RUN: %swift-format -indent-switch-case %s >%t.response
+// RUN: diff -u %s.indentswitch.response %t.response
 
 import Foundation
 
-func collatz(n: Int) {
+func collatz(n: Int, m: String?) {
+    switch m {
+    case .some(let s):
+        print(s)
+    case .none:
+        print("nothing")
+    default:
+        print("not possible")
+        break
+    }
     var r: Int
     if n%2 == 0 {
         r = n/2
diff --git a/test/swift-format/main.swift.tabs.response b/test/swift-format/main.swift.tabs.response
@@ -4,12 +4,23 @@
 // RUN: diff -u %s.indent2.response %t.response
 // RUN: %swift-format -use-tabs %s >%t.response
 // RUN: diff -u %s.tabs.response %t.response
-// RUN: %swift-format -line-range 12:18 %s >%t.response
+// RUN: %swift-format -line-range 24:29 %s >%t.response
 // RUN: diff -u %s.lines.response %t.response
+// RUN: %swift-format -indent-switch-case %s >%t.response
+// RUN: diff -u %s.indentswitch.response %t.response
 
 import Foundation
 
-func collatz(n: Int) {
+func collatz(n: Int, m: String?) {
+	switch m {
+	case .some(let s):
+		print(s)
+	case .none:
+		print("nothing")
+	default:
+		print("not possible")
+		break
+	}
 	var r: Int
 	if n%2 == 0 {
 		r = n/2
diff --git a/tools/driver/swift_format_main.cpp b/tools/driver/swift_format_main.cpp
@@ -79,10 +79,8 @@ class SwiftFormatInvocation {
   std::string MainExecutablePath;
   std::string OutputFilename = "-";
   std::vector<std::string> InputFilenames;
-  bool UseTabs = false;
+  CodeFormatOptions FormatOptions;
   bool InPlace = false;
-  unsigned TabWidth = 4;
-  unsigned IndentWidth = 4;
   std::vector<std::string> LineRanges;
 
   bool parseLineRange(StringRef Input, unsigned &FromLine, unsigned &ToLine) {
@@ -117,18 +115,21 @@ class SwiftFormatInvocation {
     }
 
     if (ParsedArgs.getLastArg(OPT_use_tabs))
-      UseTabs = true;
+      FormatOptions.UseTabs = true;
+
+    if (ParsedArgs.getLastArg(OPT_indent_switch_case))
+      FormatOptions.IndentSwitchCase = true;
 
     if (ParsedArgs.getLastArg(OPT_in_place))
       InPlace = true;
 
     if (const Arg *A = ParsedArgs.getLastArg(OPT_tab_width))
-      if (StringRef(A->getValue()).getAsInteger(10, TabWidth))
+      if (StringRef(A->getValue()).getAsInteger(10, FormatOptions.TabWidth))
         Diags.diagnose(SourceLoc(), diag::error_invalid_arg_value,
                        A->getAsString(ParsedArgs), A->getValue());
 
     if (const Arg *A = ParsedArgs.getLastArg(OPT_indent_width))
-      if (StringRef(A->getValue()).getAsInteger(10, IndentWidth))
+      if (StringRef(A->getValue()).getAsInteger(10, FormatOptions.IndentWidth))
         Diags.diagnose(SourceLoc(), diag::error_invalid_arg_value,
                        A->getAsString(ParsedArgs), A->getValue());
 
@@ -187,11 +188,6 @@ class SwiftFormatInvocation {
       LineRanges.push_back("1:" + std::to_string(UINT_MAX));
     }
 
-    CodeFormatOptions FormatOptions;
-    FormatOptions.UseTabs = UseTabs;
-    FormatOptions.IndentWidth = IndentWidth;
-    FormatOptions.TabWidth = TabWidth;
-
     std::string Output = Doc.memBuffer().getBuffer();
     for (unsigned Range = 0; Range < LineRanges.size(); ++Range) {
       unsigned FromLine;
