[SE-0289] Update diagnostics & many other strings to "result builders"

Author: DougGregor

docs/LibraryEvolution.rst

@@ -159,7 +159,7 @@ No other changes are permitted; the following are particularly of note:
   not they have default arguments.
 - An ABI-public function that throws may not become non-throwing or vice versa.
 - The ``@escaping`` attribute may not be added to or removed from a parameter.
-- Adding or removing a function builder from a parameter is a
+- Adding or removing a result builder from a parameter is a
   `binary-compatible source-breaking change`.
 
 

include/swift/AST/Attr.def

@@ -493,7 +493,7 @@ SIMPLE_DECL_ATTR(_disfavoredOverload, DisfavoredOverload,
   OnAbstractFunction | OnVar | OnSubscript | UserInaccessible |
   ABIStableToAdd | ABIStableToRemove | APIStableToAdd | APIStableToRemove,
   87)
-SIMPLE_DECL_ATTR(resultBuilder, FunctionBuilder,
+SIMPLE_DECL_ATTR(resultBuilder, ResultBuilder,
   OnNominalType |
   ABIStableToAdd | ABIStableToRemove | APIStableToAdd | APIStableToRemove,
   88)

include/swift/AST/Decl.h

@@ -2402,7 +2402,7 @@ class ValueDecl : public Decl {
   OpaqueReturnTypeRepr *getOpaqueResultTypeRepr() const;
 
   /// Retrieve the attribute associating this declaration with a
-  /// function builder, if there is one.
+  /// result builder, if there is one.
   CustomAttr *getAttachedFunctionBuilder() const;
 
   /// Retrieve the @functionBuilder type attached to this declaration,

include/swift/AST/DiagnosticsSema.def

@@ -5352,83 +5352,83 @@ ERROR(property_wrapper_missing_arg_init, none, "missing argument for parameter "
       "arguments in '@%1(...)'", (Identifier, StringRef))
 
 //------------------------------------------------------------------------------
-// MARK: function builder diagnostics
+// MARK: result builder diagnostics
 //------------------------------------------------------------------------------
-ERROR(function_builder_decl, none,
-      "closure containing a declaration cannot be used with function "
+ERROR(result_builder_decl, none,
+      "closure containing a declaration cannot be used with result "
       "builder %0", (DeclName))
-NOTE(note_function_builder_decl, none,
-      "closure containing a declaration cannot be used with function "
+NOTE(note_result_builder_decl, none,
+      "closure containing a declaration cannot be used with result "
       "builder %0", (DeclName))
-ERROR(function_builder_control_flow, none,
-      "closure containing control flow statement cannot be used with function "
+ERROR(result_builder_control_flow, none,
+      "closure containing control flow statement cannot be used with result "
       "builder %0", (DeclName))
-NOTE(note_function_builder_control_flow, none,
-      "closure containing control flow statement cannot be used with function "
+NOTE(note_result_builder_control_flow, none,
+      "closure containing control flow statement cannot be used with result "
       "builder %0", (DeclName))
-ERROR(function_builder_attribute_not_allowed_here, none,
-      "function builder attribute %0 can only be applied to a parameter, "
+ERROR(result_builder_attribute_not_allowed_here, none,
+      "result builder attribute %0 can only be applied to a parameter, "
       "function, or computed property", (Identifier))
-ERROR(function_builder_attribute_on_storage_without_getter, none,
-      "function builder attribute %0 can only be applied to a "
+ERROR(result_builder_attribute_on_storage_without_getter, none,
+      "result builder attribute %0 can only be applied to a "
       "%select{subscript|property|constant|variable}1 if it defines a getter",
       (DeclName, unsigned))
-ERROR(function_builder_parameter_not_of_function_type, none,
-      "function builder attribute %0 can only be applied to a parameter of "
+ERROR(result_builder_parameter_not_of_function_type, none,
+      "result builder attribute %0 can only be applied to a parameter of "
       "function type",
       (Identifier))
-ERROR(function_builder_parameter_autoclosure, none,
-      "function builder attribute %0 cannot be applied to an autoclosure "
+ERROR(result_builder_parameter_autoclosure, none,
+      "result builder attribute %0 cannot be applied to an autoclosure "
       "parameter",
       (Identifier))
-ERROR(function_builder_multiple, none,
-      "only one function builder attribute can be attached to a "
+ERROR(result_builder_multiple, none,
+      "only one result builder attribute can be attached to a "
       "%select{declaration|parameter}0", (bool))
-NOTE(previous_function_builder_here, none,
-     "previous function builder specified here", ())
-ERROR(function_builder_arguments, none,
-      "function builder attributes cannot have arguments", ())
-WARNING(function_builder_disabled_by_return, none,
-        "application of function builder %0 disabled by explicit 'return' "
+NOTE(previous_result_builder_here, none,
+     "previous result builder specified here", ())
+ERROR(result_builder_arguments, none,
+      "result builder attributes cannot have arguments", ())
+WARNING(result_builder_disabled_by_return, none,
+        "application of result builder %0 disabled by explicit 'return' "
         "statement", (Type))
-NOTE(function_builder_remove_attr, none,
-     "remove the attribute to explicitly disable the function builder", ())
-NOTE(function_builder_remove_returns, none,
-     "remove 'return' statements to apply the function builder", ())
-ERROR(function_builder_infer_ambig, none,
-      "ambiguous function builder inferred for %0: %1 or %2",
+NOTE(result_builder_remove_attr, none,
+     "remove the attribute to explicitly disable the result builder", ())
+NOTE(result_builder_remove_returns, none,
+     "remove 'return' statements to apply the result builder", ())
+ERROR(result_builder_infer_ambig, none,
+      "ambiguous result builder inferred for %0: %1 or %2",
       (DeclName, Type, Type))
-NOTE(function_builder_infer_add_return, none,
-     "add an explicit 'return' statement to not use a function builder", ())
-NOTE(function_builder_infer_pick_specific, none,
-     "apply function builder %0 (inferred from %select{protocol|dynamic replacement of}1 %2)",
+NOTE(result_builder_infer_add_return, none,
+     "add an explicit 'return' statement to not use a result builder", ())
+NOTE(result_builder_infer_pick_specific, none,
+     "apply result builder %0 (inferred from %select{protocol|dynamic replacement of}1 %2)",
      (Type, unsigned, DeclName))
-WARNING(function_builder_missing_limited_availability, none,
-        "function builder %0 does not implement 'buildLimitedAvailability'; "
+WARNING(result_builder_missing_limited_availability, none,
+        "result builder %0 does not implement 'buildLimitedAvailability'; "
         "this code may crash on earlier versions of the OS",
         (Type))
-ERROR(function_builder_static_buildblock, none,
-      "function builder must provide at least one static 'buildBlock' "
+ERROR(result_builder_static_buildblock, none,
+      "result builder must provide at least one static 'buildBlock' "
       "method", ())
-NOTE(function_builder_non_static_buildblock, none,
+NOTE(result_builder_non_static_buildblock, none,
      "did you mean to make instance method 'buildBlock' static?", ())
-NOTE(function_builder_buildblock_enum_case, none,
-     "enum case 'buildBlock' cannot be used to satisfy the function builder "
+NOTE(result_builder_buildblock_enum_case, none,
+     "enum case 'buildBlock' cannot be used to satisfy the result builder "
      "requirement", ())
-NOTE(function_builder_buildblock_not_static_method, none,
+NOTE(result_builder_buildblock_not_static_method, none,
      "potential match 'buildBlock' is not a static method", ())
 
-NOTE(function_builder_missing_build_optional, none,
-     "add 'buildOptional(_:)' to the function builder %0 to add support for "
+NOTE(result_builder_missing_build_optional, none,
+     "add 'buildOptional(_:)' to the result builder %0 to add support for "
      "'if' statements without an 'else'", (Type))
-NOTE(function_builder_missing_build_either, none,
-     "add 'buildEither(first:)' and 'buildEither(second:)' to the function "
+NOTE(result_builder_missing_build_either, none,
+     "add 'buildEither(first:)' and 'buildEither(second:)' to the result "
      "builder %0 to add support for 'if'-'else' and 'switch'", (Type))
-NOTE(function_builder_missing_build_array, none,
-     "add 'buildArray(_:)' to the function builder %0 to add support for "
+NOTE(result_builder_missing_build_array, none,
+     "add 'buildArray(_:)' to the result builder %0 to add support for "
      "'for'..'in' loops", (Type))
-NOTE(function_builder_missing_build_limited_availability, none,
-     "add 'buildLimitedAvailability(_:)' to the function "
+NOTE(result_builder_missing_build_limited_availability, none,
+     "add 'buildLimitedAvailability(_:)' to the result "
      "builder %0 to erase type information for less-available types", (Type))
 
 //------------------------------------------------------------------------------

include/swift/AST/EducationalNotes.def

@@ -81,15 +81,15 @@ EDUCATIONAL_NOTES(type_cannot_conform, "protocol-type-non-conformance.md")
 EDUCATIONAL_NOTES(unlabeled_trailing_closure_deprecated,
                   "trailing-closure-matching.md")
 
-EDUCATIONAL_NOTES(function_builder_static_buildblock,
+EDUCATIONAL_NOTES(result_builder_static_buildblock,
                   "function-builder-methods.md")
-EDUCATIONAL_NOTES(function_builder_missing_limited_availability,
+EDUCATIONAL_NOTES(result_builder_missing_limited_availability,
                   "function-builder-methods.md")
-EDUCATIONAL_NOTES(function_builder_missing_build_optional,
+EDUCATIONAL_NOTES(result_builder_missing_build_optional,
                   "function-builder-methods.md")
-EDUCATIONAL_NOTES(function_builder_missing_build_either,
+EDUCATIONAL_NOTES(result_builder_missing_build_either,
                   "function-builder-methods.md")
-EDUCATIONAL_NOTES(function_builder_missing_build_array,
+EDUCATIONAL_NOTES(result_builder_missing_build_array,
                   "function-builder-methods.md")
 
 #undef EDUCATIONAL_NOTES

include/swift/AST/Expr.h

@@ -3695,7 +3695,7 @@ class ClosureExpr : public AbstractClosureExpr {
     ReadyForTypeChecking,
 
     /// The body was typechecked with the enclosing closure.
-    /// i.e. single expression closure or function builder closure.
+    /// i.e. single expression closure or result builder closure.
     TypeCheckedWithSignature,
 
     /// The body was type checked separately from the enclosing closure.

include/swift/AST/TypeCheckRequests.h

@@ -735,7 +735,7 @@ void simple_display(llvm::raw_ostream &out, FragileFunctionKind value);
 
 void simple_display(llvm::raw_ostream &out, ResilienceExpansion value);
 
-/// Request the custom attribute which attaches a function builder to the
+/// Request the custom attribute which attaches a result builder to the
 /// given declaration.
 class AttachedFunctionBuilderRequest :
     public SimpleRequest<AttachedFunctionBuilderRequest,
@@ -756,7 +756,7 @@ class AttachedFunctionBuilderRequest :
   bool isCached() const;
 };
 
-/// Request the function builder type attached to the given declaration,
+/// Request the result builder type attached to the given declaration,
 /// if any.
 class FunctionBuilderTypeRequest :
     public SimpleRequest<FunctionBuilderTypeRequest,

include/swift/Sema/CSFix.h

@@ -194,7 +194,7 @@ enum class FixKind : uint8_t {
 
   /// Skip any unhandled constructs that occur within a closure argument that
   /// matches up with a
-  /// parameter that has a function builder.
+  /// parameter that has a result builder.
   SkipUnhandledConstructInFunctionBuilder,
 
   /// Allow invalid reference to a member declared as `mutating`
@@ -277,7 +277,7 @@ enum class FixKind : uint8_t {
   /// Allow key path expressions with no components.
   AllowKeyPathWithoutComponents,
 
-  /// Ignore function builder body which fails `pre-check` call.
+  /// Ignore result builder body which fails `pre-check` call.
   IgnoreInvalidFunctionBuilderBody,
 
   /// Resolve type of `nil` by providing a contextual type.
@@ -1518,7 +1518,7 @@ class SkipUnhandledConstructInFunctionBuilder final : public ConstraintFix {
 
 public:
   std::string getName() const override {
-    return "skip unhandled constructs when applying a function builder";
+    return "skip unhandled constructs when applying a result builder";
   }
 
   bool diagnose(const Solution &solution, bool asNote = false) const override;
@@ -2012,7 +2012,7 @@ class IgnoreInvalidFunctionBuilderBody final : public ConstraintFix {
 
 public:
   std::string getName() const override {
-    return "ignore invalid function builder body";
+    return "ignore invalid result builder body";
   }
 
   bool diagnose(const Solution &solution, bool asNote = false) const override;

include/swift/Sema/ConstraintLocator.h

@@ -222,7 +222,7 @@ class ConstraintLocator : public llvm::FoldingSetNode {
   /// Determine whether this locator points to the `try?` expression.
   bool isForOptionalTry() const;
 
-  /// Determine whether this locator is for a function builder body result type.
+  /// Determine whether this locator is for a result builder body result type.
   bool isForFunctionBuilderBodyResult() const;
 
   /// Determine whether this locator points directly to a given expression.

include/swift/Sema/ConstraintLocatorPathElts.def

@@ -75,7 +75,7 @@ SIMPLE_LOCATOR_PATH_ELT(FunctionArgument)
 /// The result type of a function.
 SIMPLE_LOCATOR_PATH_ELT(FunctionResult)
 
-/// The result type of a function builder body.
+/// The result type of a result builder body.
 SIMPLE_LOCATOR_PATH_ELT(FunctionBuilderBodyResult)
 
 /// A generic argument.