Merge pull request #15944 from huonw/fatalError-bodies

[IDE] Tweak replace.bodies.with.fatalError.

Author: huonw

include/swift/IDE/RefactoringKinds.def

@@ -10,6 +10,10 @@
 #define RANGE_REFACTORING(KIND, NAME, ID) SEMANTIC_REFACTORING(KIND, NAME, ID)
 #endif
 
+#ifndef INTERNAL_RANGE_REFACTORING
+#define INTERNAL_RANGE_REFACTORING(KIND, NAME, ID) RANGE_REFACTORING(KIND, NAME, ID)
+#endif
+
 #ifndef CURSOR_REFACTORING
 #define CURSOR_REFACTORING(KIND, NAME, ID) SEMANTIC_REFACTORING(KIND, NAME, ID)
 #endif
@@ -60,9 +64,14 @@ RANGE_REFACTORING(ExpandTernaryExpr, "Expand Ternary Expression", expand.ternary
 
 RANGE_REFACTORING(ConvertToTernaryExpr, "Convert To Ternary Expression", convert.ternary.expr)
 
-RANGE_REFACTORING(ReplaceBodiesWithFatalError, "Replace function bodies with fatalError", replace.bodies.with.fatalError)
+// These internal refactorings are designed to be helpful for working on
+// the compiler/standard library, etc., but are likely to be just confusing and
+// noise for general development.
+
+INTERNAL_RANGE_REFACTORING(ReplaceBodiesWithFatalError, "Replace Function Bodies With 'fatalError()'", replace.bodies.with.fatalError)
 
 #undef CURSOR_REFACTORING
+#undef INTERNAL_RANGE_REFACTORING
 #undef RANGE_REFACTORING
 #undef SEMANTIC_REFACTORING
 #undef REFACTORING

lib/IDE/Refactoring.cpp

@@ -1639,7 +1639,7 @@ bool RefactoringActionReplaceBodiesWithFatalError::isApplicable(
 }
 
 bool RefactoringActionReplaceBodiesWithFatalError::performChange() {
-  const StringRef replacement = "{ fatalError() }";
+  const StringRef replacement = "{\nfatalError()\n}";
   llvm::SmallPtrSet<Decl *, 16> Found;
   for (auto decl : RangeInfo.DeclaredDecls) {
     FindAllSubDecls(Found).walk(decl.VD);
@@ -3099,9 +3099,14 @@ collectAvailableRefactorings(SourceFile *SF, RangeConfig Range,
                          Range.getEnd(SF->getASTContext().SourceMgr));
   ResolvedRangeInfo Result = Resolver.resolve();
 
+  bool enableInternalRefactoring = getenv("SWIFT_ENABLE_INTERNAL_REFACTORING_ACTIONS");
+
 #define RANGE_REFACTORING(KIND, NAME, ID)                                     \
   if (RefactoringAction##KIND::isApplicable(Result, DiagEngine))              \
     Scratch.push_back(RefactoringKind::KIND);
+#define INTERNAL_RANGE_REFACTORING(KIND, NAME, ID)                            \
+  if (enableInternalRefactoring)                                              \
+    RANGE_REFACTORING(KIND, NAME, ID)
 #include "swift/IDE/RefactoringKinds.def"
 
   RangeStartMayNeedRename = rangeStartMayNeedRename(Result);

test/refactoring/ReplaceBodiesWithFatalError/Outputs/basic/L12-14.swift.expected

@@ -9,7 +9,9 @@ var qux: Int = 0 {
     didSet { print("bye") }
 }
 
-func generic<T>(_: T) -> Int { fatalError() }
+func generic<T>(_: T) -> Int {
+fatalError()
+}
 
 class Foo {
     var foo: Int

test/refactoring/ReplaceBodiesWithFatalError/Outputs/basic/L16-49.swift.expected

@@ -16,25 +16,43 @@ func generic<T>(_: T) -> Int {
 class Foo {
     var foo: Int
 
-    var bar: Int { fatalError() }
+    var bar: Int {
+fatalError()
+}
 
     var baz: Int {
-        get { fatalError() }
-        set { fatalError() }
+        get {
+fatalError()
+}
+        set {
+fatalError()
+}
     }
 
     var qux: Int {
-        willSet { fatalError() }
-        didSet { fatalError() }
+        willSet {
+fatalError()
+}
+        didSet {
+fatalError()
+}
     }
 
-    init() { fatalError() }
+    init() {
+fatalError()
+}
 
-    func nonGeneric() -> Int { fatalError() }
+    func nonGeneric() -> Int {
+fatalError()
+}
 
-    func generic<T>(_: T) -> Int { fatalError() }
+    func generic<T>(_: T) -> Int {
+fatalError()
+}
 
-    deinit { fatalError() }
+    deinit {
+fatalError()
+}
 }
 
 extension Foo {

test/refactoring/ReplaceBodiesWithFatalError/Outputs/basic/L19-22.swift.expected

@@ -16,7 +16,9 @@ func generic<T>(_: T) -> Int {
 class Foo {
     var foo: Int
 
-    var bar: Int { fatalError() }
+    var bar: Int {
+fatalError()
+}
 
     var baz: Int {
         get { return 0 }

test/refactoring/ReplaceBodiesWithFatalError/Outputs/basic/L3-5.swift.expected

@@ -1,6 +1,8 @@
 var foo: Int = 0
 
-var bar: Int { fatalError() }
+var bar: Int {
+fatalError()
+}
 
 var qux: Int = 0 {
     willSet { print("hi") }

test/refactoring/ReplaceBodiesWithFatalError/Outputs/basic/L30-44.swift.expected

@@ -27,14 +27,22 @@ class Foo {
 
     var qux: Int {
         willSet { print("hi") }
-        didSet { fatalError() }
+        didSet {
+fatalError()
+}
     }
 
-    init() { fatalError() }
+    init() {
+fatalError()
+}
 
-    func nonGeneric() -> Int { fatalError() }
+    func nonGeneric() -> Int {
+fatalError()
+}
 
-    func generic<T>(_: T) -> Int { fatalError() }
+    func generic<T>(_: T) -> Int {
+fatalError()
+}
 
     deinit {
         print("bye")

test/refactoring/ReplaceBodiesWithFatalError/Outputs/basic/L51-59.swift.expected

@@ -49,9 +49,13 @@ class Foo {
 }
 
 extension Foo {
-    func nonGeneric2() -> Int { fatalError() }
+    func nonGeneric2() -> Int {
+fatalError()
+}
 
-    func generic2<T>(_: T) -> Int { fatalError() }
+    func generic2<T>(_: T) -> Int {
+fatalError()
+}
 }
 
 

test/refactoring/ReplaceBodiesWithFatalError/Outputs/basic/L7-10.swift.expected

@@ -5,8 +5,12 @@ var bar: Int {
 }
 
 var qux: Int = 0 {
-    willSet { fatalError() }
-    didSet { fatalError() }
+    willSet {
+fatalError()
+}
+    didSet {
+fatalError()
+}
 }
 
 func generic<T>(_: T) -> Int {

test/refactoring/ReplaceBodiesWithFatalError/Outputs/basic/L8.swift.expected

@@ -5,7 +5,9 @@ var bar: Int {
 }
 
 var qux: Int = 0 {
-    willSet { fatalError() }
+    willSet {
+fatalError()
+}
     didSet { print("bye") }
 }
 

test/refactoring/ReplaceBodiesWithFatalError/requires-env-var.swift

@@ -0,0 +1,16 @@
+var bar: Int {
+    return 0
+}
+// CHECK-NO-ENV-LABEL: Action begins
+// CHECK-NO-ENV-NEXT: Action ends
+
+// CHECK-ENV-LABEL: Action begins
+// CHECK-ENV-NEXT: Replace Function Bodies With 'fatalError()'
+// CHECK-ENV-NEXT: Action ends
+
+// replace.bodies.with.fatalError/-replace-bodies-with-fatalError should only be
+// found if the appropriate environment variable is set.
+
+// RUN: %refactor -actions -source-filename %s -pos=1:1 -end-pos=3:2 | %FileCheck %s -check-prefix CHECK-NO-ENV
+
+// RUN: env SWIFT_ENABLE_INTERNAL_REFACTORING_ACTIONS=1 %refactor -actions -source-filename %s -pos=1:1 -end-pos=3:2 | %FileCheck %s -check-prefix CHECK-ENV